@itentialopensource/adapter-versa_director
Version:
This adapter integrates with system described as: versaDirectorApi.
1,024 lines (1,023 loc) • 28.6 kB
YAML
openapi: 3.0.0
info:
title: New Versa Director API
description: Versa Director API
contact: {}
version: '20.x'
servers:
- url: https://{defaultHost}
variables:
defaultHost:
default: www.example.com
paths:
/vnms/template/importstr:
post:
tags:
- Template
summary: importTemplateString
description: import template string
operationId: importTemplateString
parameters:
- name: templateName
in: query
description: name of the template
required: true
style: form
explode: true
schema:
type: string
requestBody:
description: workflow template
content:
application/json:
schema:
type: object
description: workflow template
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/interfaces/vni/{vni}:
put:
tags:
- Interface
summary: updatePhysicalInterfaces
description: update physical interface
operationId: updatePhysicalInterfaces
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: vni
in: path
description: name of the vni
required: true
style: simple
schema:
type: string
requestBody:
description: Interface Data
content:
application/json:
schema:
type: object
description: Interface Data
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/interfaces:
post:
tags:
- Interface
summary: addPostStagingTemplateNetworkInterface
description: create post staging template network interface
operationId: addPostStagingTemplateNetworkInterface
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
requestBody:
description: Interface Data
content:
application/json:
schema:
type: object
description: Interface Data
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/cgnat/rules/rule/{rule}:
put:
tags:
- Rule
summary: updatePostStagingTemplateCgnatRules
description: update post staging template CGNAT rules
operationId: updatePostStagingTemplateCgnatRules
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: rule
in: path
description: name of the rule
required: true
style: simple
schema:
type: string
- name: unhide
in: query
description: Whether to unhide - unhide=deprecated
style: form
explode: true
schema:
type: string
requestBody:
description: Rule Data
content:
application/json:
schema:
type: object
description: Rule Data
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-lease-profiles:
get:
tags:
- DHCP
summary: getPostStagingTemplateDhcp6LeaseProfile
description: get post staging template DHCP6 Lease Profiles
operationId: getPostStagingTemplateDhcp6LeaseProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
post:
tags:
- DHCP
summary: createPostStagingTemplateDhcp6LeaseProfile
description: create post staging template DHCP6 Lease Profiles
operationId: createPostStagingTemplateDhcp6LeaseProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Lease Profile
content:
application/json:
schema:
type: object
description: DHCP6 Lease Profile
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-lease-profiles/{leaseProfile}:
put:
tags:
- DHCP
summary: updatePostStagingTemplateDhcp6LeaseProfile
description: update post staging template DHCP6 Lease Profiles
operationId: updatePostStagingTemplateDhcp6LeaseProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: leaseProfile
in: path
description: name of the lease profile
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Lease Profile
content:
application/json:
schema:
type: object
description: DHCP6 Lease Profile
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
delete:
tags:
- DHCP
summary: deletePostStagingTemplateDhcp6LeaseProfile
description: delete post staging template DHCP6 Lease Profiles
operationId: deletePostStagingTemplateDhcp6LeaseProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: leaseProfile
in: path
description: name of the lease profile
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
enum:
- application/json
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-options-profiles:
get:
tags:
- DHCP
summary: getPostStagingTemplateDhcp6OptionsProfile
description: get post staging template DHCP6 Options Profiles
operationId: getPostStagingTemplateDhcp6OptionsProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
post:
tags:
- DHCP
summary: createPostStagingTemplateDhcp6OptionsProfile
description: create post staging template DHCP6 Options Profiles
operationId: createPostStagingTemplateDhcp6OptionsProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Options Profile
content:
application/json:
schema:
type: object
description: DHCP6 Options Profile
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-options-profiles/{optionsProfile}:
put:
tags:
- DHCP
summary: updatePostStagingTemplateDhcp6OptionsProfile
description: update post staging template DHCP6 Options Profiles
operationId: updatePostStagingTemplateDhcp6OptionsProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: optionsProfile
in: path
description: name of the options profile
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Options Profile
content:
application/json:
schema:
type: object
description: DHCP6 Options Profile
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
delete:
tags:
- DHCP
summary: deletePostStagingTemplateDhcp6OptionsProfile
description: delete post staging template DHCP6 Options Profiles
operationId: deletePostStagingTemplateDhcp6OptionsProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: optionsProfile
in: path
description: name of the options profile
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
enum:
- application/json
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-dynamic-pools:
get:
tags:
- DHCP
summary: getPostStagingTemplateDhcp6AddressPool
description: get post staging template DHCP6 Address Pool
operationId: getPostStagingTemplateDhcp6AddressPool
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
post:
tags:
- DHCP
summary: createPostStagingTemplateDhcp6AddressPool
description: create post staging template DHCP6 Address Pool
operationId: createPostStagingTemplateDhcp6AddressPool
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Address Pool
content:
application/json:
schema:
type: object
description: DHCP6 Address Pool
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-dynamic-pools/{dynamicPool}:
put:
tags:
- DHCP
summary: updatePostStagingTemplateDhcp6AddressPool
description: update post staging template DHCP6 Address Pool
operationId: updatePostStagingTemplateDhcp6AddressPool
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: dynamicPool
in: path
description: name of the dynamic pool
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Address Pool
content:
application/json:
schema:
type: object
description: DHCP6 Address Pool
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
delete:
tags:
- DHCP
summary: deletePostStagingTemplateDhcp6AddressPool
description: delete post staging template DHCP6 Address Pool
operationId: deletePostStagingTemplateDhcp6AddressPool
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: dynamicPool
in: path
description: name of the dynamic pool
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
enum:
- application/json
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
? /api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-server-and-relay/ipv6-service-profiles
: get:
tags:
- DHCP
summary: getPostStagingTemplateDhcp6Server
description: get post staging template DHCP6 Server
operationId: getPostStagingTemplateDhcp6Server
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
post:
tags:
- DHCP
summary: createPostStagingTemplateDhcp6Server
description: create post staging template DHCP6 Server
operationId: createPostStagingTemplateDhcp6Server
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Server
content:
application/json:
schema:
type: object
description: DHCP6 Server
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
? /api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/dhcp/dhcp6-server-and-relay/ipv6-service-profiles/{serviceProfile}
: put:
tags:
- DHCP
summary: updatePostStagingTemplateDhcp6Server
description: update post staging template DHCP6 Server
operationId: updatePostStagingTemplateDhcp6Server
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: serviceProfile
in: path
description: name of the service profile
required: true
style: simple
schema:
type: string
requestBody:
description: DHCP6 Server
content:
application/json:
schema:
type: object
description: DHCP6 Server
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
delete:
tags:
- DHCP
summary: deletePostStagingTemplateDhcp6Server
description: delete post staging template DHCP6 Server
operationId: deletePostStagingTemplateDhcp6Server
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: serviceProfile
in: path
description: name of the service profile
required: true
style: simple
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
enum:
- application/json
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/service-node-groups/service-node-group/{serviceNodeGroup}:
put:
tags:
- ServiceNode
summary: updatePostStagingTemplateServiceNodeGroup
description: update post staging template service node group
operationId: updatePostStagingTemplateServiceNodeGroup
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: serviceNodeGroup
in: path
description: name of the service node group
required: true
style: simple
schema:
type: string
requestBody:
description: Service Node Data
content:
application/json:
schema:
type: object
description: Service Node Data
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/networks:
post:
tags:
- Network
summary: addPostStagingTemplateNetwork
description: create post staging template network
operationId: addPostStagingTemplateNetwork
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
requestBody:
description: Network Data
content:
application/json:
schema:
type: object
description: Network Data
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org/{organization}:
get:
tags:
- Organization
summary: getPostStagingTemplateOrgLimits
description: get post staging template org limits
operationId: getPostStagingTemplateOrgLimits
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
put:
tags:
- Organization
summary: updatePostStagingTemplateOrgLimits
description: update post staging template org limits
operationId: updatePostStagingTemplateOrgLimits
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
requestBody:
description: Organization Data (HTML)
content:
text/plain:
schema:
type: string
description: Organization Data (HTML)
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
/api/config/devices/template/{templateName}/config/orgs/org-services/{organization}/ipsec/vpn-profile/{vpnProfile}:
put:
tags:
- VPN
summary: updatePostStagingTemplateIpsecVpnProfile
description: update post staging template ipsec vpn profile
operationId: updatePostStagingTemplateIpsecVpnProfile
parameters:
- name: templateName
in: path
description: name of the template
required: true
style: simple
schema:
type: string
- name: organization
in: path
description: name of the organization
required: true
style: simple
schema:
type: string
- name: vpnProfile
in: path
description: vpn profile
required: true
style: simple
schema:
type: string
- name: unhide
in: query
description: Whether to unhide - unhide=deprecated
style: form
explode: true
schema:
type: string
requestBody:
description: Network Data
content:
application/json:
schema:
type: object
description: Network Data
required: true
responses:
'200':
description: response
headers: {}
content:
application/json:
schema:
type: object
deprecated: false
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