@itentialopensource/adapter-versa_director

{ "openapi": "3.0.1", "info": { "title": "New Versa Director API", "version": "20.x", "description": "Versa Director API" }, "basePath" : "/", "paths": { "/vnms/template/importstr": { "post": { "operationId": "importTemplateString", "summary": "import template string", "tags": [ "Template" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "query", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "workflow template", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/interfaces/vni/{vni}": { "put": { "operationId": "updatePhysicalInterfaces", "summary": "update physical interface", "tags": [ "Interface" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "vni", "description": "name of the vni", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "Interface Data", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/cgnat/rules/rule/{rule}": { "put": { "operationId": "updatePostStagingTemplateCgnatRules", "summary": "update post staging template CGNAT rules", "tags": [ "Rule" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "rule", "description": "name of the rule", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "unhide", "description": "Whether to unhide - unhide=deprecated", "in": "query", "schema": { "type": "string" }, "required": false } ], "requestBody": { "required":true, "description": "Rule Data", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-lease-profiles": { "get": { "operationId": "getPostStagingTemplateDhcp6LeaseProfile", "summary": "get post staging template DHCP6 Lease Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "post": { "operationId": "createPostStagingTemplateDhcp6LeaseProfile", "summary": "create post staging template DHCP6 Lease Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Lease Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-lease-profiles/{leaseProfile}": { "put": { "operationId": "updatePostStagingTemplateDhcp6LeaseProfile", "summary": "update post staging template DHCP6 Lease Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "leaseProfile", "description": "name of the lease profile", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Lease Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "delete": { "operationId": "deletePostStagingTemplateDhcp6LeaseProfile", "summary": "delete post staging template DHCP6 Lease Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "leaseProfile", "description": "name of the lease profile", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Lease Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-options-profiles": { "get": { "operationId": "getPostStagingTemplateDhcp6OptionsProfile", "summary": "get post staging template DHCP6 Options Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "post": { "operationId": "createPostStagingTemplateDhcp6OptionsProfile", "summary": "create post staging template DHCP6 Options Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Options Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-options-profiles/{optionsProfile}": { "put": { "operationId": "updatePostStagingTemplateDhcp6OptionsProfile", "summary": "update post staging template DHCP6 Options Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "optionsProfile", "description": "name of the options profile", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Options Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "delete": { "operationId": "deletePostStagingTemplateDhcp6OptionsProfile", "summary": "delete post staging template DHCP6 Options Profiles", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "optionsProfile", "description": "name of the options profile", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Options Profile", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-dynamic-pools": { "get": { "operationId": "getPostStagingTemplateDhcp6AddressPool", "summary": "get post staging template DHCP6 Address Pool", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "post": { "operationId": "createPostStagingTemplateDhcp6AddressPool", "summary": "create post staging template DHCP6 Address Pool", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Address Pool", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-dynamic-pools/{dynamicPool}": { "put": { "operationId": "updatePostStagingTemplateDhcp6AddressPool", "summary": "update post staging template DHCP6 Address Pool", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "dynamicPool", "description": "name of the dynamic pool", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Address Pool", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "delete": { "operationId": "deletePostStagingTemplateDhcp6AddressPool", "summary": "delete post staging template DHCP6 Address Pool", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "dynamicPool", "description": "name of the dynamic pool", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Address Pool", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-server-and-relay/ipv6-service-profiles": { "get": { "operationId": "getPostStagingTemplateDhcp6Server", "summary": "get post staging template DHCP6 Server", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "post": { "operationId": "createPostStagingTemplateDhcp6Server", "summary": "create post staging template DHCP6 Server", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Server", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-server-and-relay/ipv6-service-profiles/{serviceProfile}": { "put": { "operationId": "updatePostStagingTemplateDhcp6Server", "summary": "update post staging template DHCP6 Server", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "serviceProfile", "description": "name of the service profile", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Server", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "delete": { "operationId": "deletePostStagingTemplateDhcp6Server", "summary": "delete post staging template DHCP6 Server", "tags": [ "DHCP" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "serviceProfile", "description": "name of the service profile", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "DHCP6 Server", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/service-node-groups/service-node-group/{serviceNodeGroup}": { "put": { "operationId": "updatePostStagingTemplateServiceNodeGroup", "summary": "update post staging template service node group", "tags": [ "ServiceNode" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "serviceNodeGroup", "description": "name of the service node group", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "Service Node Data", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/interfaces": { "post": { "operationId": "addPostStagingTemplateNetworkInterface", "summary": "create post staging template network interface", "tags": [ "Interface" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "Interface Data", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/networks": { "post": { "operationId": "addPostStagingTemplateNetwork", "summary": "create post staging template network", "tags": [ "Network" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "Network Data", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org/{organization}": { "get": { "operationId": "getPostStagingTemplateOrgLimits", "summary": "get post staging template org limits", "tags": [ "Organization" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } }, "put": { "operationId": "updatePostStagingTemplateOrgLimits", "summary": "update post staging template org limits", "tags": [ "Organization" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required":true, "description": "Organization Data (HTML)", "content": { "text/plain": { "schema": { "type": "string" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } }, "/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/ipsec/vpn-profile/{vpnProfile}": { "put": { "operationId": "updatePostStagingTemplateIpsecVpnProfile", "summary": "update post staging template ipsec vpn profile", "tags": [ "VPN" ], "parameters": [ { "name": "templateName", "description": "name of the template", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "organization", "description": "name of the organization", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "vpnProfile", "description": "vpn profile", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "unhide", "description": "Whether to unhide - unhide=deprecated", "in": "query", "schema": { "type": "string" }, "required": false } ], "requestBody": { "required":true, "description": "Network Data", "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "response" } } } } }, "components": { "schemas": {} }, "tags" : [ { "name" : "Template", "description" : "Template" }, { "name" : "Interface", "description" : "Interface" }, { "name" : "Rule", "description" : "Rule" }, { "name" : "DHCP", "description" : "DHCP" }, { "name" : "ServiceNode", "description" : "Service Node" }, { "name" : "Network", "description" : "Network" }, { "name" : "Organization", "description" : "Organization" }, { "name" : "VPN", "description" : "VPN" } ] }