NSD-NRCs REST API - v3

This API describes the REST interface to interact with the NSD-NRCs

More information:
Customer documentation
https://infoproducts.alcatel-lucent.com/cgi-bin/doc_welc.pl
Technical support
http://support.alcatel-lucent.com
Documentation feedback
documentation.feedback@nokia.com
BasePath:/sdn

Access

Methods

[ Jump to Models ]

Table of Contents

  1. post /api/v3/generic/find-by-external-id
  2. get /api/v3/generic/{uuid}
  3. get /api/v3/generic/application-id/{id}
  4. get /api/v3/generic/consumed/{uuid}
  5. get /api/v3/generic/tenants/{uuid}
  6. put /api/v3/generic/application-id/{id}/{appId}
  7. get /api/v3/ietf/te/link/{linkId}
  8. get /api/v3/ietf/te/network/{networkId}
  9. get /api/v3/ietf/te/networks
  10. get /api/v3/ietf/te/node/{nodeId}
  11. get /api/v3/ietf/te/termination-point/{tpId}
  12. get /api/v3/ne/{uuid}
  13. get /api/v3/ne/system/{systemId}
  14. get /api/v3/ne
  15. put /api/v3/ne/{id}
  16. post /api/v3/openflow/flows
  17. delete /api/v3/openflow/flows
  18. post /api/v3/openflow/flows/search
  19. post /api/v3/openflow/flows/search-by-id
  20. get /api/v3/openflow/ports/{datapathId}
  21. get /api/v3/openflow/switches
  22. get /api/v3/openflow/switches/{neId}
  23. get /api/v3/openflow/tables/{datapathId}
  24. post /api/v3/physicallinks/{srcId}/{destId}
  25. delete /api/v3/physicallinks/{linkId}
  26. get /api/v3/physicallinks/{uuid}
  27. get /api/v3/physicallinks
  28. post /api/v3/policy/steering-parameter
  29. post /api/v3/policy/tunnel-selections
  30. delete /api/v3/policy/steering-parameter/{steeringParameterName}
  31. delete /api/v3/policy/tunnel-selections/{policyId}
  32. get /api/v3/policy/rd-rt-ranges
  33. get /api/v3/policy/tunnel-selections
  34. get /api/v3/policy/steering-parameters
  35. get /api/v3/policy/tunnel-selections/{policyId}
  36. put /api/v3/policy/rd-rt-ranges/{policyId}
  37. put /api/v3/policy/tunnel-selections/{policyId}
  38. get /api/v3/ports/{portUuid}
  39. get /api/v3/ports/ne/{neUuid}/servicetype/{serviceType}
  40. get /api/v3/ports/ne-all/{neId}
  41. get /api/v3/ports/service-count-on-port/{portUuid}
  42. get /api/v3/ports/servicetype/{serviceType}
  43. get /api/v3/ports/tenant/{tenantUuid}
  44. put /api/v3/ports/{id}
  45. post /api/v3/security/token
  46. get /api/v3/security/authentication
  47. get /api/v3/security/token/{userName}/{password}
  48. post /api/v3/services/elans/{serviceUuid}/endpoint
  49. post /api/v3/services/l3-vpns/{serviceUuid}/endpoint
  50. post /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint
  51. post /api/v3/services/clines
  52. post /api/v3/services/elans
  53. post /api/v3/services/elines
  54. post /api/v3/services/l3-vpns
  55. post /api/v3/services/lags
  56. post /api/v3/services/optical
  57. delete /api/v3/services/{uuid}
  58. delete /api/v3/services/{serviceUuid}/endpoint/{endpointUuid}
  59. get /api/v3/services/{uuid}
  60. get /api/v3/services/{serviceUuid}/endpoints
  61. get /api/v3/services/resource-count/{tenantUuid}/{resourceType}
  62. get /api/v3/services/tenant/{uuid}
  63. get /api/v3/services/tunnel/{tunnelUuid}
  64. get /api/v3/services/tunnels
  65. get /api/v3/services
  66. patch /api/v3/services/clines/{serviceUuid}/endpoint/{endpointUuid}
  67. patch /api/v3/services/clines/{serviceUuid}
  68. patch /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid}
  69. patch /api/v3/services/elans/{serviceUuid}
  70. patch /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid}
  71. patch /api/v3/services/elines/{serviceUuid}
  72. patch /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}
  73. patch /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}
  74. patch /api/v3/services/l3-vpns/{serviceUuid}
  75. put /api/v3/services/clines/{serviceUuid}/endpoint/{endpointUuid}
  76. put /api/v3/services/clines/{serviceUuid}
  77. put /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid}
  78. put /api/v3/services/elans/{serviceUuid}
  79. put /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid}
  80. put /api/v3/services/elines/{serviceUuid}
  81. put /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}
  82. put /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}
  83. put /api/v3/services/l3-vpns/{serviceUuid}
  84. put /api/v3/services/optical/{serviceUuid}
  85. put /api/v3/services/tunnel/{tunnelUuid}
  86. post /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}/all
  87. post /api/v3/steering/as/{asNumber}
  88. post /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
  89. post /api/v3/steering/monitored-router/{id}/ports
  90. post /api/v3/steering/monitored-router
  91. post /api/v3/steering/next-hop-bundle
  92. post /api/v3/steering/vip/customer
  93. post /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
  94. post /api/v3/steering/vip/customer/{id}/subnets
  95. delete /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}/all
  96. delete /api/v3/steering/vip/customer/{id}/subnets/all
  97. delete /api/v3/steering/as/{asNumber}
  98. delete /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
  99. delete /api/v3/steering/monitored-router/{id}/ports
  100. delete /api/v3/steering/monitored-router/{id}
  101. delete /api/v3/steering/next-hop-bundle/{id}
  102. delete /api/v3/steering/vip/customer/{id}
  103. delete /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
  104. delete /api/v3/steering/vip/customer/{id}/subnets
  105. get /api/v3/steering/as/bw/{monitoredRouterId}
  106. get /api/v3/steering/as/bw/{monitoredRouterId}/{asNumber}
  107. get /api/v3/steering/as
  108. get /api/v3/steering/as/{asNumber}
  109. get /api/v3/steering/as/steer/{monitoredRouterId}
  110. get /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
  111. get /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}/details
  112. post /api/v3/steering/as/steer/search
  113. get /api/v3/steering/as/{asNumber}/subnets
  114. get /api/v3/steering/monitored-router/port/{monitoredPortId}
  115. get /api/v3/steering/monitored-router/{id}/ports
  116. get /api/v3/steering/monitored-router/{id}
  117. get /api/v3/steering/monitored-router
  118. get /api/v3/steering/next-hop-bundle/{id}
  119. post /api/v3/steering/next-hop-bundle/search
  120. get /api/v3/steering/next-hop-bundle
  121. get /api/v3/steering/monitored-router/port/{monitoredPortId}/historical-utilization/{timeStamp}
  122. get /api/v3/steering/vip/customer/{id}
  123. get /api/v3/steering/vip/bw/{monitoredRouterId}
  124. post /api/v3/steering/vip/customer/search
  125. get /api/v3/steering/vip/customer
  126. get /api/v3/steering/vip/steer/{monitoredRouterId}
  127. get /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
  128. post /api/v3/steering/vip/steer/search
  129. get /api/v3/steering/vip/bw/{monitoredRouterId}/{customerId}
  130. get /api/v3/steering/vip/customer/{id}/subnets
  131. put /api/v3/steering/as/{asNumber}
  132. put /api/v3/steering/as/{asNumber}/refresh
  133. put /api/v3/steering/monitored-router/port/{monitoredPortId}/heartbeat
  134. put /api/v3/steering/monitored-router/{id}/ports
  135. put /api/v3/steering/monitored-router/{id}
  136. put /api/v3/steering/next-hop-bundle/{id}
  137. put /api/v3/steering/vip/customer/{id}
  138. put /api/v3/steering/vip/customer/{id}/subnets
  139. get /api/v3/system/state
  140. get /api/v3/system/version
  141. get /api/v3/system/isMaster
  142. get /api/v3/system/resync-nms
  143. post /api/v3/template/cline-services
  144. post /api/v3/template/custom-attributes
  145. post /api/v3/template/elan-services
  146. post /api/v3/template/eline-services
  147. post /api/v3/template/l3-vpn-services
  148. post /api/v3/template/lag-services
  149. post /api/v3/template/och-services
  150. post /api/v3/template/odu-services
  151. post /api/v3/template/path-profiles
  152. post /api/v3/template/qos
  153. post /api/v3/template/router-id-system-id-mapping
  154. delete /api/v3/template/cline-services/{templateId}
  155. delete /api/v3/template/custom-attributes/{templateId}
  156. delete /api/v3/template/elan-services/{templateId}
  157. delete /api/v3/template/eline-services/{templateId}
  158. delete /api/v3/template/l3-vpn-services/{templateId}
  159. delete /api/v3/template/lag-services/{templateId}
  160. delete /api/v3/template/och-services/{templateId}
  161. delete /api/v3/template/odu-services/{templateId}
  162. delete /api/v3/template/path-profiles/{templateId}
  163. delete /api/v3/template/qos/{templateId}
  164. delete /api/v3/template/router-id-system-id-mapping/{policyId}
  165. get /api/v3/template/cline-services
  166. get /api/v3/template/custom-attributes
  167. get /api/v3/template/elan-services
  168. get /api/v3/template/eline-services
  169. get /api/v3/template/generic-qos
  170. get /api/v3/template/l3-vpn-services
  171. get /api/v3/template/lag-services
  172. get /api/v3/template/och-services
  173. get /api/v3/template/odu-services
  174. get /api/v3/template/path-profiles
  175. get /api/v3/template/qos
  176. get /api/v3/template/router-id-system-id-mapping
  177. get /api/v3/template/tunnel-creations
  178. get /api/v3/template/cline-services/{templateId}
  179. get /api/v3/template/custom-attributes/{templateId}
  180. get /api/v3/template/elan-services/{templateId}
  181. get /api/v3/template/eline-services/{templateId}
  182. get /api/v3/template/generic-qos/{id}
  183. get /api/v3/template/l3-vpn-services/{templateId}
  184. get /api/v3/template/lag-services/{templateId}
  185. get /api/v3/template/och-services/{templateId}
  186. get /api/v3/template/odu-services/{templateId}
  187. get /api/v3/template/path-profiles/{templateId}
  188. get /api/v3/template/qos/{templateId}
  189. get /api/v3/template/router-id-system-id-mapping/{policyId}
  190. put /api/v3/template/cline-services/{templateId}
  191. put /api/v3/template/custom-attributes/{templateId}
  192. put /api/v3/template/elan-services/{templateId}
  193. put /api/v3/template/eline-services/{templateId}
  194. put /api/v3/template/l3-vpn-services/{templateId}
  195. put /api/v3/template/lag-services/{templateId}
  196. put /api/v3/template/och-services/{templateId}
  197. put /api/v3/template/odu-services/{templateId}
  198. put /api/v3/template/path-profiles/{templateId}
  199. put /api/v3/template/qos/{templateId}
  200. put /api/v3/template/router-id-system-id-mapping/{policyId}
  201. put /api/v3/template/tunnel-creations/{templateId}
  202. post /api/v3/tenants/{tenantUuid}/resources
  203. post /api/v3/tenants
  204. post /api/v3/tenants/{tenantUuid}/user/{userUuid}/role/{roleType}
  205. delete /api/v3/tenants/{tenantUuid}
  206. delete /api/v3/tenants/{tenantUuid}/resources
  207. delete /api/v3/tenants/{tenantUuid}/user/{userUuid}
  208. get /api/v3/tenants/{tenantUuid}
  209. get /api/v3/tenants/{tenantUuid}/resources
  210. get /api/v3/tenants/{tenantUuid}/user/{userUuid}
  211. get /api/v3/tenants
  212. get /api/v3/tenants/resync/{provider}
  213. post /api/v3/users
  214. delete /api/v3/users/{userUuid}
  215. get /api/v3/users/{userUuid}
  216. get /api/v3/users/{userUuid}/tenants
  217. get /api/v3/users
  218. put /api/v3/users/{userUuid}
Up
post /api/v3/generic/find-by-external-id
Find the unique identifier of an object given an external identifier (findByExternalId)
Find the unique identifier of an object given an external identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — An external identifier to the NSP.

Return type

ResponseData«string»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«string»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/generic/{uuid}
Find an object by a unique identifier (get)
Find an object by a unique identifier

Path parameters

uuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«BaseEntity»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseEntity»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/generic/application-id/{id}
Find an object by Application ID (getApplicationId)
Find an object by Application ID

Path parameters

id (required)
Path Parameter — The Application ID of the object

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«BaseEntity»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseEntity»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/generic/consumed/{uuid}
Find all objects being consumed by an object (getConsumed)
Find all objects being consumed by an object

Path parameters

uuid (required)
Path Parameter — The unique identifier of the object

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«string»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«string»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/generic/tenants/{uuid}
Find all tenants assigned to an object (getTenants)
Find all tenants assigned to an object

Path parameters

uuid (required)
Path Parameter — The unique identifiers for the object

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«string»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«string»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/generic/application-id/{id}/{appId}
Set an object Application ID (setApplicationId)
Set an object Application ID

Path parameters

id (required)
Path Parameter — The unique identifier of the object
appId (required)
Path Parameter — The Application ID to be set

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«BaseEntity»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseEntity»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ietf/te/link/{linkId}
BETA: Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point). (getLink)
BETA: Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node, termination-point).

Path parameters

linkId (required)
Path Parameter — UUID: Identifier for a link

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Link»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Link»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ietf/te/network/{networkId}
BETA: Get TE network. A network has a UUID, attributes, a list of nodes and a list of links. (getNetwork)
BETA: Get TE network. A network has a UUID, attributes, a list of nodes and a list of links.

Path parameters

networkId (required)
Path Parameter — UUID: Identifier for a network

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Network»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Network»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ietf/te/networks
BETA: Get TE networks. A list of networks where each network has a UUID. (getNetworks)
BETA: Get TE networks. A list of networks where each network has a UUID.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Networks»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Networks»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ietf/te/node/{nodeId}
BETA: Get TE node. A node has a UUID, attributes and a list of termination-points. (getNode)
BETA: Get TE node. A node has a UUID, attributes and a list of termination-points.

Path parameters

nodeId (required)
Path Parameter — UUID: Identifier for a node

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Node»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Node»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ietf/te/termination-point/{tpId}
BETA: Get TE termination-point. A termination-point has a UUID and attributes. (getTerminationPoint)
BETA: Get TE termination-point. A termination-point has a UUID and attributes.

Path parameters

tpId (required)
Path Parameter — UUID: Identifier for a termination-point

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«TerminationPoint»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«TerminationPoint»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ne/{uuid}
Find a network element by a unique identifier (get)
Find a network element by a unique identifier

Path parameters

uuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«NetworkElement»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NetworkElement»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ne/system/{systemId}
Query a unique identifier for a Network Element by System ID (getSystem)
Query a unique identifier for a Network Element by System ID

Path parameters

systemId (required)
Path Parameter — The System ID for the Network Element to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«NetworkElement»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NetworkElement»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ne
Query all Network Elements (gets)
Query all Network Elements

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«NetworkElement»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«NetworkElement»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/ne/{id}
Update Network Element capabilities (update)
Update Network Element capabilities

Path parameters

id (required)
Path Parameter — The unique identifier of the network element

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — A request object used to modify Network Element

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/openflow/flows
Create flows (createFlows)
Create flows

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — flows

Return type

ResponseData«List«OpenflowFlowEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowFlowEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/openflow/flows
Delete flows (deleteFlows)
Delete flows

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The unique identifers of the flows to be deleted

Return type

ResponseData«List«OpenflowFlowEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowFlowEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/openflow/flows/search
Query flows based on search criteria (getFlowsearch)
Query flows based on search criteria

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Search criteria

Return type

ResponseData«List«OpenflowFlowEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowFlowEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/openflow/flows/search-by-id
Query flows based on unique identifier (getFlowsearchById)
Query flows based on unique identifier

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The unique identifiers of the flows to find

Return type

ResponseData«List«OpenflowFlowEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowFlowEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/openflow/ports/{datapathId}
Query all ports of an openflow switch (getPorts)
Query all ports of an openflow switch

Path parameters

datapathId (required)
Path Parameter — The hexadecimal openflow data-path id for this switch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«OpenflowPort»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowPort»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/openflow/switches
Query all openflow switches (getSwitches)
Query all openflow switches

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«OpenflowSwitch»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowSwitch»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/openflow/switches/{neId}
Query all openflow switches in a router (getSwitchesInRouter)
Query all openflow switches in a router

Path parameters

neId (required)
Path Parameter — The unique identifier for the selected network element router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«OpenflowSwitch»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowSwitch»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/openflow/tables/{datapathId}
Query all tables in an openflow switch (getTables)
Query all tables in an openflow switch

Path parameters

datapathId (required)
Path Parameter — The hexadecimal openflow data-path id for this switch

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«OpenflowTable»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OpenflowTable»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/physicallinks/{srcId}/{destId}
Define an undicovered physical link in NSP (create)
Define an undicovered physical link in NSP

Path parameters

srcId (required)
Path Parameter — The unique identifier for the source port
destId (required)
Path Parameter — The unique identifier for the destination port

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«PhysicalLink»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«PhysicalLink»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/physicallinks/{linkId}
Delete an undiscovered physical link that was defined in NSP (delete)
Delete an undiscovered physical link that was defined in NSP

Path parameters

linkId (required)
Path Parameter — The unique identifier for the link to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/physicallinks/{uuid}
Find a physical link by a unique identifier (get)
Find a physical link by a unique identifier

Path parameters

uuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«PhysicalLink»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«PhysicalLink»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/physicallinks
Query all physical links (gets)
Query all physical links

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«PhysicalLink»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«PhysicalLink»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/policy/steering-parameter
Create a Steering Parameter (createSteeringParameter)
Create a Steering Parameter

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — A steering parameter is used to mark tunnels and guide tunnel selection

Return type

ResponseData«SteeringParameter»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«SteeringParameter»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/policy/tunnel-selections
Create a tunnel selection policy (createTunnelSelections)
Create a tunnel selection policy

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The tunnel selection template controls system behaviour when selecting tunnels in the network

Return type

ResponseData«TunnelSelectionTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«TunnelSelectionTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/policy/steering-parameter/{steeringParameterName}
Delete a Steering Parameter (deleteSteeringParameter)
Delete a Steering Parameter

Path parameters

steeringParameterName (required)
Path Parameter — The name of the Steering Parameter to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/policy/tunnel-selections/{policyId}
Delete an existing tunnel selections policy (deleteTunnelSelections)
Delete an existing tunnel selections policy

Path parameters

policyId (required)
Path Parameter — policyId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/policy/rd-rt-ranges
Query all L3VPN RT/RD policies (getAllRdRtRanges)
Query all L3VPN RT/RD policies

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«L3vpnRdRtPolicy»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«L3vpnRdRtPolicy»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/policy/tunnel-selections
Query all tunnel selection policies (getAllTunnelSelections)
Query all tunnel selection policies

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«TunnelSelectionTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«TunnelSelectionTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/policy/steering-parameters
Query all Steering Paramters (getSteeringParameters)
Query all Steering Paramters

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«SteeringParameter»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«SteeringParameter»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/policy/tunnel-selections/{policyId}
Query a tunnel selections policy by its unique identifier (getTunnelSelections)
Query a tunnel selections policy by its unique identifier

Path parameters

policyId (required)
Path Parameter — policyId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«TunnelSelectionTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«TunnelSelectionTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/policy/rd-rt-ranges/{policyId}
Update a L3VPN RT/RD policy (updateRdRtRanges)
Update a L3VPN RT/RD policy

Path parameters

policyId (required)
Path Parameter — The unique ID of the policy that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — L3VPN RT/RD policy

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/policy/tunnel-selections/{policyId}
Update a tunnel selection policy (updateTunnelSelections)
Update a tunnel selection policy

Path parameters

policyId (required)
Path Parameter — The unique ID of the policy that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The tunnel selection template controls system behaviour when selecting tunnels in the network

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ports/{portUuid}
Find a port by unique identifier (get)
Find a port by unique identifier

Path parameters

portUuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Port»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Port»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ports/ne/{neUuid}/servicetype/{serviceType}
Query all ports of the provided network element of a service type (getNe)
Query all ports of the provided network element of a service type

Path parameters

neUuid (required)
Path Parameter — The unique identifier of the network element to be queried
serviceType (required)
Path Parameter — The service type for the port to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«Port»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«Port»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ports/ne-all/{neId}
Query all ports of the provided network element (getNeAll)
Query all ports of the provided network element

Path parameters

neId (required)
Path Parameter — The unique identifier of the network element to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«Port»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«Port»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ports/service-count-on-port/{portUuid}
Find number of services on a specified port (getServiceCountOnPort)
Find number of services on a specified port

Path parameters

portUuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«long»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«long»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ports/servicetype/{serviceType}
Find all ports in the network that support a given service type (getServicetype)
Find all ports in the network that support a given service type

Path parameters

serviceType (required)
Path Parameter — The service type for the port to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«Port»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«Port»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/ports/tenant/{tenantUuid}
Find all ports in the network that are assigned a given Tenant (getTenant)
Find all ports in the network that are assigned a given Tenant

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«Port»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«Port»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/ports/{id}
Update the port (update)
Update the port

Path parameters

id (required)
Path Parameter — The unique identifier of the port to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — A request object used to modify Port

Return type

ResponseData«Port»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Port»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/security/token
Login with username and password to acquire a token - To be removed for 17.6 release (createToken)
Login with username and password to acquire a token - To be removed for 17.6 release

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The user authentication information

Return type

ResponseData«NspToken»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NspToken»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/security/authentication
Retrieve information about the currently-authenticated user from the perspective of the system (getAuthentication)
Retrieve information about the currently-authenticated user from the perspective of the system

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Authentication»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Authentication»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/security/token/{userName}/{password}
Acquire a token - To be removed for 17.6 release (getToken)
Acquire a token - To be removed for 17.6 release

Path parameters

userName (required)
Path Parameter — The username to be associated with the acquired token
password (required)
Path Parameter — The password used with the specified username

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«NspToken»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NspToken»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/elans/{serviceUuid}/endpoint
Add an endpoint to an E-LAN service (addElanEndpoint)
Add an endpoint to an E-LAN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The Layer 2 endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/l3-vpns/{serviceUuid}/endpoint
Add an endpoint to an L3 VPN service (addL3VpnEndpoint)
Add an endpoint to an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — l3EndpointRequest

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint
Add a loop back endpoint to an L3 VPN service (addL3VpnLoopbackEndpoint)
Add a loop back endpoint to an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The LoopBack endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/clines
Create a C-Line service (createClines)
Create a C-Line service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized IP C-Line service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/elans
Create an E-LAN VPN service (createElans)
Create an E-LAN VPN service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized E-LAN service request

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/elines
Create an IP or optical E-Line service (createElines)
Create an IP or optical E-Line service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/l3-vpns
Create an L3 VPN service (createL3Vpns)
Create an L3 VPN service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized L3 VPN service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/lags
Create or modify a LAG service (createLags)
Create or modify a LAG service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized LAG service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/services/optical
Create or modify an optical service (createOptical)
Create or modify an optical service

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized Optical service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/services/{uuid}
Delete a service (delete)
Delete a service

Path parameters

uuid (required)
Path Parameter — The unique identifier of the service to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/services/{serviceUuid}/endpoint/{endpointUuid}
Delete a service endpoint from a service (deleteServiceEndpoint)
Delete a service endpoint from a service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services/{uuid}
Find a service by a unique identifier (get)
Find a service by a unique identifier

Path parameters

uuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services/{serviceUuid}/endpoints
Query all endpoints associated to a service object (getEndpoints)
Query all endpoints associated to a service object

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier for the service to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«BaseServiceEndpoint»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«BaseServiceEndpoint»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services/resource-count/{tenantUuid}/{resourceType}
Obtain tenant resource count (getResourceCount)
Obtain tenant resource count

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be queried
resourceType (required)
Path Parameter — The resource type to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«long»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«long»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services/tenant/{uuid}
Find all services that are assigned to a tenant (getTenant)
Find all services that are assigned to a tenant

Path parameters

uuid (required)
Path Parameter — The unique identifier for the tenant to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«BaseService»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«BaseService»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services/tunnel/{tunnelUuid}
Find a Tunnel (getTunnel)
Find a Tunnel

Path parameters

tunnelUuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«ServiceTunnel»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ServiceTunnel»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services/tunnels
Query all Tunnels (getTunnels)
Query all Tunnels

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«ServiceTunnel»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«ServiceTunnel»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/services
Query all service objects (gets)
Query all service objects

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«BaseService»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«BaseService»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/clines/{serviceUuid}/endpoint/{endpointUuid}
Patch the endpoint of a C-Line service (patchClineEndpoint)
Patch the endpoint of a C-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The TDM DS0 channel group definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/clines/{serviceUuid}
Patch a C-Line service (patchClines)
Patch a C-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized IP C-Line service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid}
Patch the endpoint of an E-LAN service (patchElanEndpoint)
Patch the endpoint of an E-LAN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The Layer 2 endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/elans/{serviceUuid}
Patch an E-LAN service (patchElans)
Patch an E-LAN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized E-LAN service request

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid}
Patch the endpoint of an E-Line service (patchElineEndpoint)
Patch the endpoint of an E-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The Layer 2 endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/elines/{serviceUuid}
Patch an IP or optical E-Line service (patchElines)
Patch an IP or optical E-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}
Patch endpoint of an L3 VPN service (patchL3VpnEndpoint)
Patch endpoint of an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — l3EndpointRequest

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}
Patch loop back endpoint of an L3 VPN service (patchL3VpnLoopbackEndpoint)
Patch loop back endpoint of an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The LoopBack endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
patch /api/v3/services/l3-vpns/{serviceUuid}
Patch an L3 VPN service (patchL3Vpns)
Patch an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being patched

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized L3 VPN service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/clines/{serviceUuid}/endpoint/{endpointUuid}
Update the endpoint of a C-Line service (updateClineEndpoint)
Update the endpoint of a C-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be updated

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The TDM DS0 channel group definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/clines/{serviceUuid}
Modify a C-Line service (updateClines)
Modify a C-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized IP C-Line service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid}
Update the endpoint of an E-LAN service (updateElanEndpoint)
Update the endpoint of an E-LAN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The Layer 2 endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/elans/{serviceUuid}
Modify an E-LAN service (updateElans)
Modify an E-LAN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized E-LAN service request

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid}
Update the endpoint of an E-Line service (updateElineEndpoint)
Update the endpoint of an E-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be updated

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The Layer 2 endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/elines/{serviceUuid}
Modify an IP or optical E-Line service (updateElines)
Modify an IP or optical E-Line service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized IP or Optical E-Line service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}
Update endpoint of an L3 VPN service (updateL3VpnEndpoint)
Update endpoint of an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — l3EndpointRequest

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}
Update loop back endpoint of an L3 VPN service (updateL3VpnLoopbackEndpoint)
Update loop back endpoint of an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service to which the endpoint belongs
endpointUuid (required)
Path Parameter — The unique identifier of the service endpoint to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The LoopBack endpoint definition

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/l3-vpns/{serviceUuid}
Modify an L3 VPN service (updateL3Vpns)
Modify an L3 VPN service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized L3 VPN service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/optical/{serviceUuid}
Modify an optical service (updateOptical)
Modify an optical service

Path parameters

serviceUuid (required)
Path Parameter — The unique identifier of the service that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The normalized Optical service request. This object is used to create and modify service entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/services/tunnel/{tunnelUuid}
Modify a tunnel (updateTunnel)
Modify a tunnel

Path parameters

tunnelUuid (required)
Path Parameter — The unique identifier of the tunnel that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — A request object used to modify tunnel entities in the network.

Return type

ResponseData«BaseService»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«BaseService»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}/all
Steer all VIP subnets on a monitored router for a customer (createAllVipSteeringEntry)
Steer all VIP subnets on a monitored router for a customer

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
customerId (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — vipAllSubnetSteeringEntryRequest

Return type

ResponseData«VipSteeringEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipSteeringEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/as/{asNumber}
Create an Autonomous System entry (createAsEntry)
Create an Autonomous System entry

Path parameters

asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — asEntryRequest

Return type

ResponseData«AsEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«AsEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
Steer an Autonomous System on a monitored router (createAsSteeringEntry)
Steer an Autonomous System on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — asSteeringEntryRequest

Return type

ResponseData«AsSteeringEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«AsSteeringEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/monitored-router/{id}/ports
Add monitored ports to a monitored router (createMonitoredPorts)
Add monitored ports to a monitored router

Path parameters

id (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — portList

Return type

ResponseData«List«MonitoredPort»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«MonitoredPort»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/monitored-router
Create a monitored router bound to a Network Element (createMonitoredRouter)
Create a monitored router bound to a Network Element

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Monitored router configuration

Return type

ResponseData«MonitoredRouter»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«MonitoredRouter»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/next-hop-bundle
Create a next hop bundle (createNextHopBundle)
Create a next hop bundle

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — nextHopBundleRequest

Return type

ResponseData«NextHopBundle»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NextHopBundle»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/vip/customer
Create a VIP steering customer (createVipCustomer)
Create a VIP steering customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — VIP customer configuration

Return type

ResponseData«VipCustomerEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipCustomerEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
Steer VIP subnets on a monitored router (createVipSteeringEntry)
Steer VIP subnets on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
customerId (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — subnetSteeringList

Return type

ResponseData«VipSteeringEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipSteeringEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/vip/customer/{id}/subnets
Add subnets to a VIP customer (createVipSubnets)
Add subnets to a VIP customer

Path parameters

id (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — subnetList

Return type

ResponseData«List«VipSubnetEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipSubnetEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}/all
Remove all steering of VIP subnets on a monitored router (deleteAllVipSteeringEntry)
Remove all steering of VIP subnets on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
customerId (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/vip/customer/{id}/subnets/all
Remove all subnets from a VIP customer (deleteAllVipSubnets)
Remove all subnets from a VIP customer

Path parameters

id (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/as/{asNumber}
Delete an Autonomous System entry (deleteAsEntry)
Delete an Autonomous System entry

Path parameters

asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
Remove steering of an Autonomous System on a monitored router (deleteAsSteeringEntry)
Remove steering of an Autonomous System on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/monitored-router/{id}/ports
Remove monitored ports on a monitored-router (deleteMonitoredPorts)
Remove monitored ports on a monitored-router

Path parameters

id (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The unique identifiers of the monitored ports to be deleted

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/monitored-router/{id}
Delete a monitored router (deleteMonitoredRouter)
Delete a monitored router

Path parameters

id (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/next-hop-bundle/{id}
Delete a next hop bundle (deleteNextHopBundle)
Delete a next hop bundle

Path parameters

id (required)
Path Parameter — The unique identifier for the bundle

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/vip/customer/{id}
Delete a VIP customer for VIP steering (deleteVipCustomer)
Delete a VIP customer for VIP steering

Path parameters

id (required)
Path Parameter — The unique identifier of the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
Remove steering of VIP subnets on a monitored router (deleteVipSteeringEntry)
Remove steering of VIP subnets on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
customerId (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The unique identifiers of the subnets to have steering removed

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/steering/vip/customer/{id}/subnets
Remove subnets from a VIP customer (deleteVipSubnets)
Remove subnets from a VIP customer

Path parameters

id (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The unique identifiers of the subnets to be removed

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/bw/{monitoredRouterId}
Query bandwidth of all Autonomous Systems on a monitored router (getAsBwAll)
Query bandwidth of all Autonomous Systems on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier of the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«AsBw»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«AsBw»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/bw/{monitoredRouterId}/{asNumber}
Query bandwidth of one Autonomous System on a monitored router (getAsBwSingle)
Query bandwidth of one Autonomous System on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier of the monitored router
asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«AsBw»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«AsBw»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as
Query all Autonomous System entries (getAsEntries)
Query all Autonomous System entries

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«AsEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«AsEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/{asNumber}
Query an Autonomous System entry (getAsEntry)
Query an Autonomous System entry

Path parameters

asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«AsEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«AsEntry»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/steer/{monitoredRouterId}
Query steering state of all Autonomous Systems on a monitored router (getAsSteeringEntries)
Query steering state of all Autonomous Systems on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«AsSteeringEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«AsSteeringEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
Query steering state of an Autonomous Systems on a monitored router (getAsSteeringEntry)
Query steering state of an Autonomous Systems on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«AsSteeringEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«AsSteeringEntry»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}/details
Query steering details of an Autonomous System on a monitored router (getAsSteeringEntryDetail)
Query steering details of an Autonomous System on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«AsSteeringEntryDetail»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«AsSteeringEntryDetail»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/as/steer/search
Query steering state of all Autonomous Systems on a next hop address (getAsSteeringEntrySearch)
Query steering state of all Autonomous Systems on a next hop address

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Search for a steering entry

Return type

ResponseData«List«AsSteeringEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«AsSteeringEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/as/{asNumber}/subnets
Query all subnets of an Autonomous System (getAsSubnets)
Query all subnets of an Autonomous System

Path parameters

asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«AsSubnetEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«AsSubnetEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/monitored-router/port/{monitoredPortId}
Query a monitored port (getMonitoredPort)
Query a monitored port

Path parameters

monitoredPortId (required)
Path Parameter — The unique identifier of the port

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«MonitoredPort»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«MonitoredPort»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/monitored-router/{id}/ports
Query all monitored ports on a monitored router (getMonitoredPorts)
Query all monitored ports on a monitored router

Path parameters

id (required)
Path Parameter — The unique identifier of the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«MonitoredPort»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«MonitoredPort»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/monitored-router/{id}
Query a monitored router (getMonitoredRouter)
Query a monitored router

Path parameters

id (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«MonitoredRouter»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«MonitoredRouter»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/monitored-router
Query all monitored routers (getMonitoredRouters)
Query all monitored routers

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«MonitoredRouter»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«MonitoredRouter»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/next-hop-bundle/{id}
Query a next hop bundle (getNextHopBundle)
Query a next hop bundle

Path parameters

id (required)
Path Parameter — The unique identifier for the bundle

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«NextHopBundle»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NextHopBundle»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/next-hop-bundle/search
Query next hop bundle based on IP address (getNextHopBundleSearch)
Query next hop bundle based on IP address

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Search for a next hop

Return type

ResponseData«List«NextHopBundle»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«NextHopBundle»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/next-hop-bundle
Query all next hop bundles (getNextHopBundles)
Query all next hop bundles

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«NextHopBundle»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«NextHopBundle»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/monitored-router/port/{monitoredPortId}/historical-utilization/{timeStamp}
Query a monitored port's historical utilization (getPortUtilization)
Query a monitored port's historical utilization

Path parameters

monitoredPortId (required)
Path Parameter — The unique identifier of the monitored port
timeStamp (required)
Path Parameter — Retrieve utilization starting from this time-stamp; use YANG date-and-time format

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«PortUtilizationHistory»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«PortUtilizationHistory»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/customer/{id}
Query a VIP steering customer (getVipCustomer)
Query a VIP steering customer

Path parameters

id (required)
Path Parameter — The unique identifier of the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«VipCustomerEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipCustomerEntry»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/bw/{monitoredRouterId}
Query bandwidth of all VIP customers on a monitored router (getVipCustomerBw)
Query bandwidth of all VIP customers on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«VipCustomerBwEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipCustomerBwEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/vip/customer/search
Query VIP customers overlapping a subnet IP address (getVipCustomerSearch)
Query VIP customers overlapping a subnet IP address

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — VIP subnet data

Return type

ResponseData«List«VipCustomerEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipCustomerEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/customer
Query all VIP steering customers (getVipCustomers)
Query all VIP steering customers

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«VipCustomerEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipCustomerEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/steer/{monitoredRouterId}
Query all VIP customers that are steered on a monitored router (getVipSteeringAllCustomerEntry)
Query all VIP customers that are steered on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«VipSteeringEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipSteeringEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
Query steering of VIP subnets on a monitored router (getVipSteeringEntry)
Query steering of VIP subnets on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
customerId (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«VipSteeringEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipSteeringEntry»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/steering/vip/steer/search
Query all VIP customers that are steered on a next hop address (getVipSteeringEntrySearch)
Query all VIP customers that are steered on a next hop address

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Search for a steering entry

Return type

ResponseData«List«VipSteeringEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipSteeringEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/bw/{monitoredRouterId}/{customerId}
Query bandwidth of a VIP customer's subnets on a monitored router (getVipSubnetBw)
Query bandwidth of a VIP customer's subnets on a monitored router

Path parameters

monitoredRouterId (required)
Path Parameter — The unique identifier for the monitored router
customerId (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«VipCustomerAndSubnetBwEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipCustomerAndSubnetBwEntry»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/steering/vip/customer/{id}/subnets
Query all subnets of a VIP customer (getVipSubnets)
Query all subnets of a VIP customer

Path parameters

id (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«VipSubnetEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipSubnetEntry»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/as/{asNumber}
Update an Autonomous System entry (setAsEntry)
Update an Autonomous System entry

Path parameters

asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — asEntryRequest

Return type

ResponseData«AsEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«AsEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/as/{asNumber}/refresh
Refresh subnets of an Autonomous System (setAsEntryRefresh)
Refresh subnets of an Autonomous System

Path parameters

asNumber (required)
Path Parameter — The number of the Autonomous System

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/monitored-router/port/{monitoredPortId}/heartbeat
Heartbeat for real-time stats collection on a monitored port (setMonitoredPortHeartbeatRealTimeStats)
Heartbeat for real-time stats collection on a monitored port

Path parameters

monitoredPortId (required)
Path Parameter — The unique identifier of the monitored port

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/monitored-router/{id}/ports
Assign monitored ports to a monitored router (setMonitoredPorts)
Assign monitored ports to a monitored router

Path parameters

id (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — portList

Return type

ResponseData«List«MonitoredPort»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«MonitoredPort»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/monitored-router/{id}
Update a monitored router (setMonitoredRouter)
Update a monitored router

Path parameters

id (required)
Path Parameter — The unique identifier for the monitored router

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Monitored router configuration

Return type

ResponseData«MonitoredRouter»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«MonitoredRouter»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/next-hop-bundle/{id}
Update a next hop bundle (setNextHopBundle)
Update a next hop bundle

Path parameters

id (required)
Path Parameter — The unique identifier for the bundle

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — nextHopBundleModifyRequest

Return type

ResponseData«NextHopBundle»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«NextHopBundle»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/vip/customer/{id}
Update a VIP steering customer (setVipCustomer)
Update a VIP steering customer

Path parameters

id (required)
Path Parameter — The unique identifier of the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — VIP customer configuration

Return type

ResponseData«VipCustomerEntry»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«VipCustomerEntry»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/steering/vip/customer/{id}/subnets
Set subnets on a VIP customer (setVipSubnets)
Set subnets on a VIP customer

Path parameters

id (required)
Path Parameter — The unique identifier for the VIP customer

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — subnetList

Return type

ResponseData«List«VipSubnetEntry»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«VipSubnetEntry»»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/system/state
Retrieves the state of the system (getState)
Retrieves the state of the system

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«string»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«string»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/system/version
Retrieves the version of the system (getVersion)
Retrieves the version of the system

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«string»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«string»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/system/isMaster
NSP server is master (isMaster)
NSP server is master

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/system/resync-nms
Triggers a data synchronization with the connected NMS (resyncNms)
Triggers a data synchronization with the connected NMS

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/cline-services
Create a C-Line service creation template (createClineServices)
Create a C-Line service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during C-Line service creation

Return type

ResponseData«ClineServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ClineServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/custom-attributes
Create a Custom Attributes template (createCustomAttributes)
Create a Custom Attributes template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — custom attributes template

Return type

ResponseData«CustomAttributesTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«CustomAttributesTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/elan-services
Create an E-LAN service creation template (createElanServices)
Create an E-LAN service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during E-LAN service creation

Return type

ResponseData«ElanServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ElanServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/eline-services
Create an E-Line service creation template (createElineServices)
Create an E-Line service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during E-Line service creation

Return type

ResponseData«ElineServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ElineServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/l3-vpn-services
Create an L3 VPN service creation template (createL3VpnServices)
Create an L3 VPN service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during L3 VPN service creation

Return type

ResponseData«L3vpnServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«L3vpnServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/lag-services
Create a LAG service creation template (createLagServices)
Create a LAG service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during LAG service creation

Return type

ResponseData«LagServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«LagServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/och-services
Create an OCH service creation template (createOchServices)
Create an OCH service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during OCH service creation

Return type

ResponseData«OchServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«OchServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/odu-services
Create an ODU service creation template (createOduServices)
Create an ODU service creation template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during ODU service creation

Return type

ResponseData«OduServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«OduServiceCreationTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/path-profiles
Create a path profile template (createPathProfiles)
Create a path profile template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The path profile template controls computation parameters for creating paths in the network

Return type

ResponseData«PathProfileTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«PathProfileTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/qos
Create a QoS template (createQos)
Create a QoS template

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Qos template that defines cir & pir

Return type

ResponseData«QosTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«QosTemplate»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/template/router-id-system-id-mapping
Create a router ID system ID mapping policy (createRouterIdSystemIdMapping)
Create a router ID system ID mapping policy

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Policy template that defines system ID and router ID mapping.

Return type

ResponseData«RouterIdSystemIdMapping»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«RouterIdSystemIdMapping»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/cline-services/{templateId}
Delete a C-Line service creation template (deleteClineServices)
Delete a C-Line service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/custom-attributes/{templateId}
Delete a Custom Attributes template (deleteCustomAttributes)
Delete a Custom Attributes template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/elan-services/{templateId}
Delete an E-LAN service creation template (deleteElanServices)
Delete an E-LAN service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/eline-services/{templateId}
Delete an E-Line service creation template (deleteElineServices)
Delete an E-Line service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/l3-vpn-services/{templateId}
Delete an L3 VPN service creation template (deleteL3VpnServices)
Delete an L3 VPN service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/lag-services/{templateId}
Delete a LAG service creation template (deleteLagServices)
Delete a LAG service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/och-services/{templateId}
Delete an OCH service creation template (deleteOchServices)
Delete an OCH service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/odu-services/{templateId}
Delete an ODU service creation template (deleteOduServices)
Delete an ODU service creation template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/path-profiles/{templateId}
Delete an existing path profile template (deletePathProfiles)
Delete an existing path profile template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/qos/{templateId}
Delete a QoS template (deleteQos)
Delete a QoS template

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/template/router-id-system-id-mapping/{policyId}
Delete a router-id-mapping policy (deleteRouterIdSystemIdMapping)
Delete a router-id-mapping policy

Path parameters

policyId (required)
Path Parameter — policyId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/cline-services
Query all C-Line service creation templates (getAllClineServices)
Query all C-Line service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«ClineServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«ClineServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/custom-attributes
Query all Custom Attributes templates (getAllCustomAttributes)
Query all Custom Attributes templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«CustomAttributesTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«CustomAttributesTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/elan-services
Query all E-LAN service creation templates (getAllElanServices)
Query all E-LAN service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«ElanServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«ElanServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/eline-services
Query all E-Line service creation templates (getAllElineServices)
Query all E-Line service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«ElineServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«ElineServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/generic-qos
Query all generic QoS profiles. (getAllGenericQos)
Query all generic QoS profiles.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«QosProfile»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«QosProfile»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/l3-vpn-services
Query all L3 VPN service creation templates (getAllL3VpnServices)
Query all L3 VPN service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«L3vpnServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«L3vpnServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/lag-services
Query all LAG service creation templates (getAllLagServices)
Query all LAG service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«LagServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«LagServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/och-services
Query all OCH service creation templates (getAllOchServices)
Query all OCH service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«OchServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OchServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/odu-services
Query all ODU service creation templates (getAllOduServices)
Query all ODU service creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«OduServiceCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«OduServiceCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/path-profiles
Query all path profile templates (getAllPathProfiles)
Query all path profile templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«PathProfileTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«PathProfileTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/qos
Query all QoS templates (getAllQos)
Query all QoS templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«QosTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«QosTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/router-id-system-id-mapping
Query all router ID system ID mapping policy (getAllRouterIdSystemIdMappings)
Query all router ID system ID mapping policy

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«RouterIdSystemIdMapping»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«RouterIdSystemIdMapping»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/tunnel-creations
Query all tunnel creation templates (getAllTunnelCreations)
Query all tunnel creation templates

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«TunnelCreationTemplate»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«TunnelCreationTemplate»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/cline-services/{templateId}
Find a C-Line service creation template by its unique identifier (getClineServices)
Find a C-Line service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«ClineServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ClineServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/custom-attributes/{templateId}
Find a Custom Attributes template by its unique identifier (getCustomAttributes)
Find a Custom Attributes template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«CustomAttributesTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«CustomAttributesTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/elan-services/{templateId}
Find an E-LAN service creation template by its unique identifier (getElanServices)
Find an E-LAN service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«ElanServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ElanServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/eline-services/{templateId}
Find an E-Line service creation template by its unique identifier (getElineServices)
Find an E-Line service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«ElineServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«ElineServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/generic-qos/{id}
Find a generic QoS profile by its unique ID (getGenericQos)
Find a generic QoS profile by its unique ID

Path parameters

id (required)
Path Parameter — id

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«QosProfile»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«QosProfile»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/l3-vpn-services/{templateId}
Find an L3 VPN service creation template by its unique identifier (getL3VpnServices)
Find an L3 VPN service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«L3vpnServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«L3vpnServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/lag-services/{templateId}
Find a LAG service creation template by its unique identifier (getLagServices)
Find a LAG service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«LagServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«LagServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/och-services/{templateId}
Find an OCH service creation template by its unique identifier (getOchServices)
Find an OCH service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«OchServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«OchServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/odu-services/{templateId}
Find an ODU service creation template by its unique identifier (getOduServices)
Find an ODU service creation template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«OduServiceCreationTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«OduServiceCreationTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/path-profiles/{templateId}
Find a path profile template by its unique identifier (getPathProfiles)
Find a path profile template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«PathProfileTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«PathProfileTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/qos/{templateId}
Find a QoS template by its unique identifier (getQos)
Find a QoS template by its unique identifier

Path parameters

templateId (required)
Path Parameter — templateId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«QosTemplate»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«QosTemplate»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/template/router-id-system-id-mapping/{policyId}
Find a router-id-system-id-mapping by its unique identifier (getRouterIdSystemIdMapping)
Find a router-id-system-id-mapping by its unique identifier

Path parameters

policyId (required)
Path Parameter — policyId

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«RouterIdSystemIdMapping»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«RouterIdSystemIdMapping»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/cline-services/{templateId}
Modify a C-Line service creation template (updateClineServices)
Modify a C-Line service creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during C-Line service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/custom-attributes/{templateId}
Modify a Custom Attributes template (updateCustomAttributes)
Modify a Custom Attributes template

Path parameters

templateId (required)
Path Parameter — The unique identifier of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — custom attributes template

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/elan-services/{templateId}
Modify an E-LAN service creation template (updateElanServices)
Modify an E-LAN service creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during E-LAN service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/eline-services/{templateId}
Modify an E-Line service creation template (updateElineServices)
Modify an E-Line service creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during E-Line service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/l3-vpn-services/{templateId}
Modify an L3 VPN service creation template (updateL3VpnServices)
Modify an L3 VPN service creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during L3 VPN service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/lag-services/{templateId}
Modify a LAG service creation template (updateLagServices)
Modify a LAG service creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during LAG service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/och-services/{templateId}
Modify an OCH service creation template (updateOchServices)
Modify an OCH service creation template

Path parameters

templateId (required)
Path Parameter — The unique identifier of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during OCH service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/odu-services/{templateId}
Modify an ODU service creation template (updateOduServices)
Modify an ODU service creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — This template is used during ODU service creation

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/path-profiles/{templateId}
Update a path profile template (updatePathProfiles)
Update a path profile template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The path profile template controls computation parameters for creating paths in the network

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/qos/{templateId}
Modify a QoS template (updateQos)
Modify a QoS template

Path parameters

templateId (required)
Path Parameter — The unique identifier of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Qos template that defines cir & pir

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/router-id-system-id-mapping/{policyId}
Modify a router-id-system-id-mapping policy (updateRouterIdSystemIdMapping)
Modify a router-id-system-id-mapping policy

Path parameters

policyId (required)
Path Parameter — The unique ID of the policy that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — Policy template that defines system ID and router ID mapping.

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/template/tunnel-creations/{templateId}
Modify a tunnel creation template (updateTunnelCreations)
Modify a tunnel creation template

Path parameters

templateId (required)
Path Parameter — The unique ID of the template that is being modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The tunnel creation template controls system behaviour when automatically creating tunnels in the network

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/tenants/{tenantUuid}/resources
Assign resources to a tenant (addResources)
Assign resources to a tenant

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The resource unique identifier(s) to be assigned to the tenant

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/tenants
Create an NSP Tenant (create)
Create an NSP Tenant

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — A tenant is a logical group that allows the assigning of network resources

Return type

ResponseData«Tenant»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Tenant»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/tenants/{tenantUuid}/user/{userUuid}/role/{roleType}
Assign a user to a tenant - To be removed for 17.6 release (createUser)
Assign a user to a tenant - To be removed for 17.6 release

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be modified
userUuid (required)
Path Parameter — The unique identifier of the user to be assigned
roleType (required)
Path Parameter — The role that the user will be assigned on the tenant. Operator can read/write on in its assigned tenant. User is read-only for its tenant. Admin is read/write across all tenants.

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/tenants/{tenantUuid}
Delete a Tenant (delete)
Delete a Tenant

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the Tenant to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/tenants/{tenantUuid}/resources
Remove resources from a tenant (deleteResources)
Remove resources from a tenant

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to be modified

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The resource unique identifier(s) to be removed from the tenant

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/tenants/{tenantUuid}/user/{userUuid}
Remove a user from a tenant - To be removed for 17.6 release (deleteUser)
Remove a user from a tenant - To be removed for 17.6 release

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to which the user is assigned
userUuid (required)
Path Parameter — The unique identifier of the user to be removed

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/tenants/{tenantUuid}
Find a Tenant (get)
Find a Tenant

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«Tenant»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«Tenant»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/tenants/{tenantUuid}/resources
Find all resources assigned to a tenant (getResources)
Find all resources assigned to a tenant

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier for the tenant

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«BaseEntity»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«BaseEntity»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/tenants/{tenantUuid}/user/{userUuid}
Find a user's assigned role on a tenant - To be removed for 17.6 release (getUser)
Find a user's assigned role on a tenant - To be removed for 17.6 release

Path parameters

tenantUuid (required)
Path Parameter — The unique identifier of the tenant to which the user is assigned
userUuid (required)
Path Parameter — The unique identifier of the user to be found

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«string»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«string»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/tenants
Query all Tenants (gets)
Query all Tenants

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«Tenant»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«Tenant»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/tenants/resync/{provider}
Resynchronize data with an Identity Provider (resync)
Resynchronize data with an Identity Provider

Path parameters

provider (required)
Path Parameter — The Identity Provider in which to resynchronize data

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
post /api/v3/users
Create a user - To be removed for 17.6 release (create)
Create a user - To be removed for 17.6 release

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The user authentication information

Return type

ResponseData«User»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«User»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
delete /api/v3/users/{userUuid}
Delete a user - To be removed for 17.6 release (delete)
Delete a user - To be removed for 17.6 release

Path parameters

userUuid (required)
Path Parameter — The unique identifier for the user to be deleted

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«boolean»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«boolean»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

204

No Content

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/users/{userUuid}
Find a user by a unique identifier - To be removed for 17.6 release (get)
Find a user by a unique identifier - To be removed for 17.6 release

Path parameters

userUuid (required)
Path Parameter — The unique identifier for the query

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«User»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«User»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/users/{userUuid}/tenants
Find all tenants assigned to user based on unique identifier - To be removed for 17.6 release (getTenants)
Find all tenants assigned to user based on unique identifier - To be removed for 17.6 release

Path parameters

userUuid (required)
Path Parameter — The unique identifier for the User to be queried

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«Tenant»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«Tenant»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
get /api/v3/users
Query all Users - To be removed for 17.6 release (gets)
Query all Users - To be removed for 17.6 release

Consumes

This API call consumes the following media types via the Content-Type request header:

Return type

ResponseData«List«User»»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«List«User»»

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up
put /api/v3/users/{userUuid}
Update a user - To be removed for 17.6 release (update)
Update a user - To be removed for 17.6 release

Path parameters

userUuid (required)
Path Parameter — The unique identifier for the user to be updated

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (optional)
Body Parameter — The user authentication information

Return type

ResponseData«User»

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

success ResponseData«User»

201

Created

400

Bad Request - Malformed content or invalid data provided ErrorResponseData

401

Unauthorized - Authentication rejected ErrorResponseData

500

Internal Server Error - Unrecognized system error ErrorResponseData

403

Forbidden - Authorization rejected ErrorResponseData

404

Not Found - Resource does not exist ErrorResponseData

409

Conflict - System not ready ErrorResponseData

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AdminGroup
  2. AdminGroups
  3. AsBw
  4. AsEntry
  5. AsEntryRequest
  6. AsNumber
  7. AsSteeringEntry
  8. AsSteeringEntryDetail
  9. AsSteeringEntryRequest
  10. AsSubnetEntry
  11. Authentication
  12. BaseEntity
  13. BaseService
  14. BaseServiceEndpoint
  15. BundledLink
  16. BundledLinks
  17. ClineServiceCreationTemplate
  18. ClineServiceRequest
  19. ComponentLink
  20. ComponentLinks
  21. Config
  22. ConnectivityLabelRestrictionList
  23. ConnectivityMatrix
  24. CosMapping
  25. CustomAttribute
  26. CustomAttributesTemplate
  27. DateAndTime
  28. Destination
  29. DomainName
  30. DottedQuad
  31. EbgpRoute
  32. EgressParam
  33. ElanServiceCreationTemplate
  34. ElineRequestData
  35. ElineServiceCreationTemplate
  36. EndpointList
  37. Entry«int,double»
  38. Entry«long,BundledLink»
  39. Entry«long,ComponentLink»
  40. Entry«long,ConnectivityMatrix»
  41. Entry«long,Schedule»
  42. Entry«long,TePathElement»
  43. Entry«long,UnderlayBackupPath»
  44. Entry«string,InformationSourceEntry»
  45. Entry«string,InterfaceSwitchingCapability»
  46. Entry«string,LabelRestriction»
  47. Entry«string,LinkTemplate»
  48. Entry«string,Link»
  49. Entry«string,Network»
  50. Entry«string,NodeTemplate»
  51. Entry«string,Node»
  52. Entry«string,SupportingLink»
  53. Entry«string,SupportingNode»
  54. Entry«string,SupportingTerminationPoint»
  55. Entry«string,TeNodeStateDerivedInformationSourceEntry»
  56. Entry«string,TerminationCapability»
  57. Entry«string,TerminationPoint»
  58. Entry«string,TunnelTerminationPoint»
  59. ErrorMessages
  60. ErrorReport
  61. ErrorReports
  62. ErrorResponseData
  63. Ethernet
  64. ExtendedAdminGroup
  65. ExternalDomain
  66. ExternalId
  67. From
  68. GeneralizedLabel
  69. GeoLocation
  70. GroupConnection
  71. InformationSourceAttributes
  72. InformationSourceEntry
  73. InformationSourceState
  74. IngressParam
  75. InterfaceSwitchingCapability
  76. InterfaceSwitchingCapabilityList
  77. IpAddress
  78. IpElanServiceRequest
  79. IpL3ServiceRequest
  80. IpPrefix
  81. Ipv4Address
  82. Ipv4Prefix
  83. Ipv6Address
  84. Ipv6Prefix
  85. L2EndpointRequest
  86. L3EndpointRequest
  87. L3vpnRdRtPolicy
  88. L3vpnServiceCreationTemplate
  89. LabelRestriction
  90. Lag
  91. LagMemberInfo
  92. LagRequest
  93. LagServiceCreationTemplate
  94. LifeCycle
  95. Link
  96. LinkCost
  97. LinkId
  98. LinkTemplate
  99. LldpConfigurationInfo
  100. LldpRemotePeerInfo
  101. LoopbackEndpointRequest
  102. LspEncodingTypes
  103. LspProtType
  104. Measurement
  105. MonitoredPort
  106. MonitoredPortRequest
  107. MonitoredRouter
  108. MonitoredRouterModifyRequest
  109. MonitoredRouterRequest
  110. Network
  111. NetworkElement
  112. NetworkElementRequest
  113. NetworkId
  114. NetworkIdentifierType
  115. NetworkTypes
  116. Networks
  117. NextHopBundle
  118. NextHopBundleModifyRequest
  119. NextHopBundleRequest
  120. NextHopBundleSearch
  121. Node
  122. NodeId
  123. NodeTemplate
  124. Normality
  125. NspOpticsExplicitRoute
  126. NspToken
  127. OchServiceCreationTemplate
  128. OduServiceCreationTemplate
  129. OpenflowAction
  130. OpenflowFlowEntry
  131. OpenflowFlowEntryRequest
  132. OpenflowFlowSearch
  133. OpenflowFlowSearchById
  134. OpenflowInstruction
  135. OpenflowMatch
  136. OpenflowPort
  137. OpenflowSwitch
  138. OpenflowTable
  139. Optics
  140. OpticsRequest
  141. Ownership
  142. PathProfileTemplate
  143. PerformanceMetric
  144. PerformanceMetricAttributes
  145. PerformanceMetricNormalityAttributes
  146. PerformanceMetricThrottle
  147. PerformanceMetricThrottleContainer
  148. PhysicalLink
  149. Platform
  150. Port
  151. PortRequest
  152. PortUtilizationHistory
  153. QosProfile
  154. QosTemplate
  155. Queue
  156. Recovery
  157. Request«AsEntryRequest»
  158. Request«AsSteeringEntryRequest»
  159. Request«ClineServiceCreationTemplate»
  160. Request«ClineServiceRequest»
  161. Request«CustomAttributesTemplate»
  162. Request«ElanServiceCreationTemplate»
  163. Request«ElineRequestData»
  164. Request«ElineServiceCreationTemplate»
  165. Request«ExternalId»
  166. Request«IpElanServiceRequest»
  167. Request«IpL3ServiceRequest»
  168. Request«L2EndpointRequest»
  169. Request«L3EndpointRequest»
  170. Request«L3vpnRdRtPolicy»
  171. Request«L3vpnServiceCreationTemplate»
  172. Request«LagRequest»
  173. Request«LagServiceCreationTemplate»
  174. Request«List«MonitoredPortRequest»»
  175. Request«List«OpenflowFlowEntryRequest»»
  176. Request«List«VipSubnetEntryRequest»»
  177. Request«List«VipSubnetSteeringEntryRequest»»
  178. Request«List«string»»
  179. Request«LoopbackEndpointRequest»
  180. Request«MonitoredRouterModifyRequest»
  181. Request«MonitoredRouterRequest»
  182. Request«NetworkElementRequest»
  183. Request«NextHopBundleModifyRequest»
  184. Request«NextHopBundleRequest»
  185. Request«NextHopBundleSearch»
  186. Request«OchServiceCreationTemplate»
  187. Request«OduServiceCreationTemplate»
  188. Request«OpenflowFlowSearchById»
  189. Request«OpenflowFlowSearch»
  190. Request«OpticsRequest»
  191. Request«PathProfileTemplate»
  192. Request«PortRequest»
  193. Request«QosTemplate»
  194. Request«RouterIdSystemIdMapping»
  195. Request«ServiceTunnelRequest»
  196. Request«SteeringEntrySearch»
  197. Request«SteeringParameter»
  198. Request«TdmEndpointRequest»
  199. Request«Tenant»
  200. Request«TunnelCreationTemplate»
  201. Request«TunnelSelectionTemplate»
  202. Request«UserInfo»
  203. Request«VipAllSubnetSteeringEntryRequest»
  204. Request«VipCustomerEntryRequest»
  205. Request«VipSubnetEntryRequest»
  206. ResponseData«AsBw»
  207. ResponseData«AsEntry»
  208. ResponseData«AsSteeringEntry»
  209. ResponseData«Authentication»
  210. ResponseData«BaseEntity»
  211. ResponseData«BaseService»
  212. ResponseData«ClineServiceCreationTemplate»
  213. ResponseData«CustomAttributesTemplate»
  214. ResponseData«ElanServiceCreationTemplate»
  215. ResponseData«ElineServiceCreationTemplate»
  216. ResponseData«L3vpnServiceCreationTemplate»
  217. ResponseData«LagServiceCreationTemplate»
  218. ResponseData«Link»
  219. ResponseData«List«AsBw»»
  220. ResponseData«List«AsEntry»»
  221. ResponseData«List«AsSteeringEntryDetail»»
  222. ResponseData«List«AsSteeringEntry»»
  223. ResponseData«List«AsSubnetEntry»»
  224. ResponseData«List«BaseEntity»»
  225. ResponseData«List«BaseServiceEndpoint»»
  226. ResponseData«List«BaseService»»
  227. ResponseData«List«ClineServiceCreationTemplate»»
  228. ResponseData«List«CustomAttributesTemplate»»
  229. ResponseData«List«ElanServiceCreationTemplate»»
  230. ResponseData«List«ElineServiceCreationTemplate»»
  231. ResponseData«List«L3vpnRdRtPolicy»»
  232. ResponseData«List«L3vpnServiceCreationTemplate»»
  233. ResponseData«List«LagServiceCreationTemplate»»
  234. ResponseData«List«MonitoredPort»»
  235. ResponseData«List«MonitoredRouter»»
  236. ResponseData«List«NetworkElement»»
  237. ResponseData«List«NextHopBundle»»
  238. ResponseData«List«OchServiceCreationTemplate»»
  239. ResponseData«List«OduServiceCreationTemplate»»
  240. ResponseData«List«OpenflowFlowEntry»»
  241. ResponseData«List«OpenflowPort»»
  242. ResponseData«List«OpenflowSwitch»»
  243. ResponseData«List«OpenflowTable»»
  244. ResponseData«List«PathProfileTemplate»»
  245. ResponseData«List«PhysicalLink»»
  246. ResponseData«List«PortUtilizationHistory»»
  247. ResponseData«List«Port»»
  248. ResponseData«List«QosProfile»»
  249. ResponseData«List«QosTemplate»»
  250. ResponseData«List«RouterIdSystemIdMapping»»
  251. ResponseData«List«ServiceTunnel»»
  252. ResponseData«List«SteeringParameter»»
  253. ResponseData«List«Tenant»»
  254. ResponseData«List«TunnelCreationTemplate»»
  255. ResponseData«List«TunnelSelectionTemplate»»
  256. ResponseData«List«User»»
  257. ResponseData«List«VipCustomerBwEntry»»
  258. ResponseData«List«VipCustomerEntry»»
  259. ResponseData«List«VipSteeringEntry»»
  260. ResponseData«List«VipSubnetEntry»»
  261. ResponseData«List«string»»
  262. ResponseData«MonitoredPort»
  263. ResponseData«MonitoredRouter»
  264. ResponseData«NetworkElement»
  265. ResponseData«Networks»
  266. ResponseData«Network»
  267. ResponseData«NextHopBundle»
  268. ResponseData«Node»
  269. ResponseData«NspToken»
  270. ResponseData«OchServiceCreationTemplate»
  271. ResponseData«OduServiceCreationTemplate»
  272. ResponseData«PathProfileTemplate»
  273. ResponseData«PhysicalLink»
  274. ResponseData«Port»
  275. ResponseData«QosProfile»
  276. ResponseData«QosTemplate»
  277. ResponseData«RouterIdSystemIdMapping»
  278. ResponseData«ServiceTunnel»
  279. ResponseData«SteeringParameter»
  280. ResponseData«Tenant»
  281. ResponseData«TerminationPoint»
  282. ResponseData«TunnelSelectionTemplate»
  283. ResponseData«User»
  284. ResponseData«VipCustomerAndSubnetBwEntry»
  285. ResponseData«VipCustomerEntry»
  286. ResponseData«VipSteeringEntry»
  287. ResponseData«boolean»
  288. ResponseData«long»
  289. ResponseData«string»
  290. Response«AsBw»
  291. Response«AsEntry»
  292. Response«AsSteeringEntry»
  293. Response«Authentication»
  294. Response«BaseEntity»
  295. Response«BaseService»
  296. Response«ClineServiceCreationTemplate»
  297. Response«CustomAttributesTemplate»
  298. Response«ElanServiceCreationTemplate»
  299. Response«ElineServiceCreationTemplate»
  300. Response«ErrorMessages»
  301. Response«L3vpnServiceCreationTemplate»
  302. Response«LagServiceCreationTemplate»
  303. Response«Link»
  304. Response«List«AsBw»»
  305. Response«List«AsEntry»»
  306. Response«List«AsSteeringEntryDetail»»
  307. Response«List«AsSteeringEntry»»
  308. Response«List«AsSubnetEntry»»
  309. Response«List«BaseEntity»»
  310. Response«List«BaseServiceEndpoint»»
  311. Response«List«BaseService»»
  312. Response«List«ClineServiceCreationTemplate»»
  313. Response«List«CustomAttributesTemplate»»
  314. Response«List«ElanServiceCreationTemplate»»
  315. Response«List«ElineServiceCreationTemplate»»
  316. Response«List«L3vpnRdRtPolicy»»
  317. Response«List«L3vpnServiceCreationTemplate»»
  318. Response«List«LagServiceCreationTemplate»»
  319. Response«List«MonitoredPort»»
  320. Response«List«MonitoredRouter»»
  321. Response«List«NetworkElement»»
  322. Response«List«NextHopBundle»»
  323. Response«List«OchServiceCreationTemplate»»
  324. Response«List«OduServiceCreationTemplate»»
  325. Response«List«OpenflowFlowEntry»»
  326. Response«List«OpenflowPort»»
  327. Response«List«OpenflowSwitch»»
  328. Response«List«OpenflowTable»»
  329. Response«List«PathProfileTemplate»»
  330. Response«List«PhysicalLink»»
  331. Response«List«PortUtilizationHistory»»
  332. Response«List«Port»»
  333. Response«List«QosProfile»»
  334. Response«List«QosTemplate»»
  335. Response«List«RouterIdSystemIdMapping»»
  336. Response«List«ServiceTunnel»»
  337. Response«List«SteeringParameter»»
  338. Response«List«Tenant»»
  339. Response«List«TunnelCreationTemplate»»
  340. Response«List«TunnelSelectionTemplate»»
  341. Response«List«User»»
  342. Response«List«VipCustomerBwEntry»»
  343. Response«List«VipCustomerEntry»»
  344. Response«List«VipSteeringEntry»»
  345. Response«List«VipSubnetEntry»»
  346. Response«List«string»»
  347. Response«MonitoredPort»
  348. Response«MonitoredRouter»
  349. Response«NetworkElement»
  350. Response«Networks»
  351. Response«Network»
  352. Response«NextHopBundle»
  353. Response«Node»
  354. Response«NspToken»
  355. Response«OchServiceCreationTemplate»
  356. Response«OduServiceCreationTemplate»
  357. Response«PathProfileTemplate»
  358. Response«PhysicalLink»
  359. Response«Port»
  360. Response«QosProfile»
  361. Response«QosTemplate»
  362. Response«RouterIdSystemIdMapping»
  363. Response«ServiceTunnel»
  364. Response«SteeringParameter»
  365. Response«Tenant»
  366. Response«TerminationPoint»
  367. Response«TunnelSelectionTemplate»
  368. Response«User»
  369. Response«VipCustomerAndSubnetBwEntry»
  370. Response«VipCustomerEntry»
  371. Response«VipSteeringEntry»
  372. Response«boolean»
  373. Response«long»
  374. Response«string»
  375. RouteTarget
  376. RouterIdSystemIdMapping
  377. RouterInfo
  378. RoutingBgp
  379. RoutingStatic
  380. Schedule
  381. Scheduler
  382. Schedules
  383. SchedulesMember
  384. ServiceEdge
  385. ServiceTopology
  386. ServiceTunnel
  387. ServiceTunnelRequest
  388. SiteServiceQosProfile
  389. Source
  390. Srlg
  391. State
  392. StaticRoute
  393. SteeringEntrySearch
  394. SteeringParameter
  395. SupportingLink
  396. SupportingNode
  397. SupportingTerminationPoint
  398. SwitchingCapabilities
  399. Tdm
  400. TdmDs0ChannelGroupInfo
  401. TdmEndpointRequest
  402. Te
  403. TeGlobalId
  404. TeLinkAttributes
  405. TeLinkAugment
  406. TeLinkConfig
  407. TeLinkConfigAttributes
  408. TeLinkConnectivityAttributes
  409. TeLinkInfoAttributes
  410. TeLinkStateDerived
  411. TeLinkStateDerivedUnderlay
  412. TeLinkStateUnderlayAttributes
  413. TeLinkUnderlayAttributes
  414. TeNodeAttributes
  415. TeNodeAugment
  416. TeNodeAugmentTe
  417. TeNodeAugmentTeConfig
  418. TeNodeAugmentTeState
  419. TeNodeConfig
  420. TeNodeConfigAttributesTemplate
  421. TeNodeConfigAttributesTemplateTeNodeAttributes
  422. TeNodeConnectivityMatrix
  423. TeNodeId
  424. TeNodeInfoAttributes
  425. TeNodeStateDerived
  426. TeNodeStateDerivedInformationSourceEntry
  427. TeNodeTunnelTerminationCapability
  428. TeOptimizationCriterion
  429. TePathElement
  430. TePerformanceMetric
  431. TeSrlgs
  432. TeTemplateName
  433. TeTerminationPointAugment
  434. TeTerminationPointAugmentTe
  435. TeTerminationPointAugmentTeConfig
  436. TeTerminationPointAugmentTeState
  437. TeTerminationPointConfig
  438. TeTopologiesAugment
  439. TeTopologiesAugmentTe
  440. TeTopologyAugment
  441. TeTopologyAugmentTe
  442. TeTopologyAugmentTeConfig
  443. TeTopologyAugmentTeState
  444. TeTopologyConfig
  445. TeTopologyHierarchy
  446. TeTopologyId
  447. TeTopologyRef
  448. TeTpId
  449. Template
  450. TemplateAttributes
  451. Templates
  452. Tenant
  453. TerminationCapability
  454. TerminationPoint
  455. ThresholdAcceleratedAdvertisement
  456. ThresholdIn
  457. ThresholdOut
  458. Tier1Scheduler
  459. TimeDivisionMultiplexCapable
  460. To
  461. Topology
  462. TpId
  463. TpRef
  464. TunnelCreationTemplate
  465. TunnelSelectionTemplate
  466. TunnelTerminationPoint
  467. Underlay
  468. UnderlayBackupPath
  469. UnderlayPrimaryPath
  470. UnderlayTopology
  471. UnderlayTrailDes
  472. UnderlayTrailSrc
  473. Uri
  474. UrlSafeString
  475. User
  476. UserInfo
  477. VipAllSubnetSteeringEntryRequest
  478. VipCustomerAndSubnetBwEntry
  479. VipCustomerBwEntry
  480. VipCustomerEntry
  481. VipCustomerEntryRequest
  482. VipSteeringEntry
  483. VipSubnetBwEntry
  484. VipSubnetEntry
  485. VipSubnetEntryRequest
  486. VipSubnetSteeringEntry
  487. VipSubnetSteeringEntryRequest

AdminGroup Up

binary (optional)

AdminGroups Up

adminGroup (optional)
extendedAdminGroup (optional)

AsBw Up

asNumber (optional)
Long The number of the Autonomous System we are interested in steering
bandwidth (optional)
Long Bandwidth in kbps

AsEntry Up

appGroupId (optional)
Long Application group ID used by steered flows for this Autonomous System
applicationId (optional)
Integer The Autonomous System steering Application ID
asNumber (optional)
Long The number of the Autonomous System
lastSubnetsChangeTime (optional)
DateAndTime Date and time-stamp for the last time subnets data is changed
lastSubnetsRefreshTime (optional)
DateAndTime Date and time-stamp for the last time subnets data is refreshed
name (optional)
String The name of the Autonomous System
subnetCount (optional)
Long The number of sub-networks present in the Autonomous System

AsEntryRequest Up

name (optional)
String The name of the Autonomous System

AsNumber Up

uint32 (optional)

AsSteeringEntry Up

asNumber (optional)
Long The number of the Autonomous System we are steering
deploymentStatus (optional)
String Indicates the status of deploying subnets related flows
Enum:
SUCCESS
PENDING
FAILURE
IN_PROCESS
lastSubnetsDeployTime (optional)
DateAndTime Date and time-stamp for the last time subnets related flows are deployed
monitoredRouterId (optional)
String The unique identifier for the monitored router we are steering
nextHopBundleIds (optional)
array[String] The unique identifier of the next hop bundle(s) this AS is steered to
nextHopIpAddress (optional)
IpAddress The IP address of the next hop this AS is steered to

AsSteeringEntryDetail Up

flowId (optional)
String The unique identifier of the flow used for steering
subnetPrefix (optional)
IpPrefix Subnet prefix

AsSteeringEntryRequest Up

nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to

AsSubnetEntry Up

subnetPrefix (optional)
IpPrefix Subnet prefix

Authentication Up

expires (optional)
Long Specifies the expiry date of the token in milliseconds since January 1, 1970, 00:00:00 GMT
roles (optional)
array[String] The role(s) this User has relative to their Tenant
tenant (optional)
Tenant The Tenant in which the current user is currently authenticated against
user (optional)
User The User currently authenticated

BaseEntity Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP

BaseService Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
bidirectional (optional)
String Specifies whether a return path is required, and if so, what type of return path will be used. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
connectionState (optional)
String The connection state for the service
Enum:
DISCONNECTED
CONNECTED
UNKNOWN
endpoints (optional)
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
lifeCycle (optional)
LifeCycle The Life Cycle details for a given object.
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String The name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceType (optional)
String The type of the service
Enum:
ODU
TUNNEL
PHYSICAL_LINK
LAG
CLINE
ELAN
OCH
ELINE
L3_VPN
templateId (optional)
String Specifies the identifier of the template to apply to the service.
tenants (optional)
topology (optional)
String The logical topology of the service
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service

BaseServiceEndpoint Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
name (optional)
String The name of the service endpoint
neId (optional)
String The identifier of the network element where the service endpoint resides
neName (optional)
String The name of the network element to which this endpoint belongs
portId (optional)
String The identifier of the port upon which the service endpoint resides
serviceId (optional)
String The identifier of the service that uses this endpoint

BundledLink Up

desTpRef (optional)
String Reference to another TE termination point on the same destination node.
sequence (optional)
Long Identify the sequence in the bundle.
srcTpRef (optional)
String Reference to another TE termination point on the same souruce node.

BundledLinks Up

bundledLink (optional)

ClineServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service.
Enum:
MAINTENANCE
DOWN
UP
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
mtu (optional)
Long The MTU for the service. The valid values are between 0 and 9194.
qosId (optional)
String The ID of the default QoS template associated with the service. Not Supported on C-Line templates
qosName (optional)
String The name of the default QoS template associated with the service. Not Supported on C-Line templates
tunnelSelectionId (optional)
String The ID of the Tunnel Selection template associated with the service
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE

ClineServiceRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
action (optional)
String Specifies the action to perform on the service
Enum:
TRACE
DISCOVER
UPDATE
TRAVERSE
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
mtu (optional)
Long The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values.
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
cemUseRtpHeader (optional)
Boolean Enable the inclusion of RTP header. It is disabled by default.
endpoints (optional)

ComponentLink Up

desInterfaceRef (optional)
String Reference to component link interface on the destinatioin node.
sequence (optional)
Long Identify the sequence in the bundle.
srcInterfaceRef (optional)
String Reference to component link interface on the source node.

ComponentLinks Up

componentLink (optional)

Config Up

teLinkConfig (optional)
TeLinkConfig TE link configuration grouping.

ConnectivityLabelRestrictionList Up

labelRestriction (optional)

ConnectivityMatrix Up

from (optional)
From Reference to source NTP.
to (optional)
To Reference to destination NTP.
connectivityLabelRestrictionList (optional)
teLinkConnectivityAttributes (optional)
id (optional)
Long Identifies the connectivity-matrix entry.

CosMapping Up

cos (optional)
String Class of Service for the qos profile
queueId (optional)
Integer The ID of an endpoint queue.

CustomAttribute Up

attributeName (optional)
String custom attribute name
attributeValue (optional)
String custom attribute value

CustomAttributesTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
customAttributes (optional)

DateAndTime Up

string (optional)

Destination Up

destNode (optional)
String Destination node identifier, must be in the same network.
destTp (optional)
String Termination point within destination node that terminates the link.

DomainName Up

string (optional)

DottedQuad Up

string (optional)

EbgpRoute Up

peerIpAddress (optional)
IpAddress The name of the Peer group for the Peer resent the next-hop address. Mandatory for Post only
peerAS (optional)
Long Autonomous System number for the remote peer. Mandatory for Post only

EgressParam Up

tier1Scheduler (optional)
Tier1Scheduler Tier1 Egress QoS scheduler parameters

ElanServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service.
Enum:
MAINTENANCE
DOWN
UP
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
mtu (optional)
Long The MTU for the service. The valid values are between 0 and 9194.
qosId (optional)
String The ID of the default QoS template associated with the service. Not Supported on C-Line templates
qosName (optional)
String The name of the default QoS template associated with the service. Not Supported on C-Line templates
tunnelSelectionId (optional)
String The ID of the Tunnel Selection template associated with the service
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE

ElineRequestData Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
action (optional)
String Specifies the action to perform on the service
Enum:
TRACE
DISCOVER
UPDATE
TRAVERSE
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
mtu (optional)
Long The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values.
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
endpoints (optional)
monitorBandwidth (optional)
Boolean Specifies whether or not the bandwidth utilization of the service will be monitored

ElineServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service.
Enum:
MAINTENANCE
DOWN
UP
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
mtu (optional)
Long The MTU for the service. The valid values are between 0 and 9194.
qosId (optional)
String The ID of the default QoS template associated with the service. Not Supported on C-Line templates
qosName (optional)
String The name of the default QoS template associated with the service. Not Supported on C-Line templates
tunnelSelectionId (optional)
String The ID of the Tunnel Selection template associated with the service
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE

EndpointList Up

endpointConnectionConfig (optional)
String Specifies how the service endpoints in each of the groups are connected
Enum:
detached
full_mesh
endpointId (optional)
array[String] Specifies a list of endpoints making up the grouping
groupName (optional)
String A name that identifies the grouping within a service

Entry«int,double» Up

key (optional)

Entry«long,BundledLink» Up

key (optional)

Entry«long,ComponentLink» Up

key (optional)

Entry«long,ConnectivityMatrix» Up

key (optional)

Entry«long,Schedule» Up

key (optional)

Entry«long,TePathElement» Up

key (optional)

Entry«long,UnderlayBackupPath» Up

key (optional)

Entry«string,InformationSourceEntry» Up

key (optional)

Entry«string,InterfaceSwitchingCapability» Up

key (optional)

Entry«string,LabelRestriction» Up

key (optional)

Entry«string,LinkTemplate» Up

key (optional)

Entry«string,Link» Up

key (optional)

Entry«string,Network» Up

key (optional)

Entry«string,NodeTemplate» Up

key (optional)

Entry«string,Node» Up

key (optional)

Entry«string,SupportingLink» Up

key (optional)

Entry«string,SupportingNode» Up

key (optional)

Entry«string,SupportingTerminationPoint» Up

key (optional)

Entry«string,TeNodeStateDerivedInformationSourceEntry» Up

key (optional)

Entry«string,TerminationCapability» Up

key (optional)

Entry«string,TerminationPoint» Up

key (optional)

Entry«string,TunnelTerminationPoint» Up

key (optional)

ErrorMessages Up

errorReports (optional)
errors (optional)
array[String] Descriptive message of one or many errors

ErrorReport Up

errorAppTag (optional)
String The application-specific error tag
errorInfo (optional)
Object This anydata value MUST represent a container with zero or more data nodes representing additional error information
errorMsg (optional)
String A message describing the error
errorPath (optional)
String The instance identifier associated with the error node
errorTag (optional)
String The enumerated error tag
errorType (optional)
String The protocol layer where the error occurred
Enum:
protocol
application
rpc_notification
transport

ErrorReports Up

errorReport (optional)

ErrorResponseData Up

response (optional)

Ethernet Up

encapType (optional)
String The encapsulation type of the ethernet port
Enum:
Null
Unknown
Dot1Q
QinQ
lag (optional)
Lag Contains LAG related configuration
lldpConfiguration (optional)
lldpRemotePeers (optional)

ExtendedAdminGroup Up

binary (optional)

ExternalDomain Up

plugId (optional)
Long A topology-wide unique number that identifies on the network a connectivity supporting a given inter-domain TE link. This is more flexible alternative to specifying remote-te-node-id and remote-te-link-tp-id, when the provider does not know remote-te-node-id and remote-te-link-tp-id or need to give client the flexibility to mix-n-match multiple topologies.
remoteTeLinkTpId (optional)
TeTpId Remote TE link termination point identifier, used together with remote-te-node-id to identify the remote link termination point in a different domain.
remoteTeNodeId (optional)
TeNodeId Remote TE node identifier, used together with remote-te-link-id to identify the remote link termination point in a different domain.

ExternalId Up

context (optional)
String The entity type that is managing this external-id
Enum:
OMS
NODE
SAM
id (optional)
String The local identifier used on the entity.
location (optional)
array[String] The entity instance that is managing this external-id. This may be an IP address or a DNS name.

From Up

tpRef (optional)
String Relative reference to source termination point.

GeneralizedLabel Up

binary (optional)

GeoLocation Up

latitude (optional)
Double The latitude of the geographical location in degrees
longitude (optional)
Double The longitude of the geographical location in degrees

GroupConnection Up

groupA (optional)
String Specifies a group upon which to terminate the connectivity
groupB (optional)
String Specifies a group upon which to terminate the connectivity

InformationSourceAttributes Up

informationSource (optional)
String Indicates the source of the information.
Enum:
other
locally_configured
ospfv2
isis
ospfv3
system_processed
unknown
informationSourceState (optional)
InformationSourceState The container contains state attributes related to the information source.

InformationSourceEntry Up

informationSourceAttributes (optional)
teLinkInfoAttributes (optional)

InformationSourceState Up

credibilityPreference (optional)
Integer The preference value to calculate the traffic engineering database credibility value used for tie-break selection between different information-source values. Higher value is more preferable.
routingInstance (optional)
String When applicable, this is the name of a routing instance from which the information is learned.
topology (optional)
Topology When the information is processed by the system, the attributes in this container indicate which topology is used to process to generate the result information.

IngressParam Up

tier1Scheduler (optional)
Tier1Scheduler Tier1 Ingress QoS scheduler parameters

InterfaceSwitchingCapability Up

timeDivisionMultiplexCapable (optional)
TimeDivisionMultiplexCapable Interface has time-division multiplex capabilities.
maxLspBandwidth (optional)
encoding (optional)
LspEncodingTypes Encoding supported by this interface.
switchingCapability (optional)
SwitchingCapabilities Switching Capability for this interface.

InterfaceSwitchingCapabilityList Up

interfaceSwitchingCapability (optional)

IpAddress Up

ipv4Address (optional)
ipv6Address (optional)

IpElanServiceRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
action (optional)
String Specifies the action to perform on the service
Enum:
TRACE
DISCOVER
UPDATE
TRAVERSE
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
mtu (optional)
Long The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values.
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
topology (optional)
Topology The logical topology of a multipoint service
endpoints (optional)

IpL3ServiceRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
action (optional)
String Specifies the action to perform on the service
Enum:
TRACE
DISCOVER
UPDATE
TRAVERSE
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
mtu (optional)
Long The MTU for the service. For L3 VPN services, the valid values are 0 or between 512 and 9000, and this is applied to all endpoints. For E-Line/E-LAN/C-Line services, the valid values are between 0 and 9194. A value of 0 means to use the default MTU of the equipment (the default usually corresponds to the value of the underlying transport medium). Note that for a composite service this may result in the segments having incompatible MTU values.
vcType (optional)
String The type of the pseudowire. For E-Line/E-LAN services, the valid values are Ethernet Tagged Mode (4) or Ethernet (5). For C-Line services, the valid values are SATOP E1 (11), SATOP T1 (12), CESOPSN (15) or CESOPSN CAS (17)
Enum:
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
topology (optional)
Topology The logical topology of a multipoint service
autobind (optional)
String The type of autobind to be used for the service
Enum:
rsvp_te
ldp
gre
none
encryption (optional)
Boolean Specifies whether or not Network Group Encryption is enabled for the service
endpoints (optional)
loopbackEndpoints (optional)

IpPrefix Up

ipv6Prefix (optional)
ipv4Prefix (optional)

Ipv4Address Up

string (optional)

Ipv4Prefix Up

string (optional)

Ipv6Address Up

string (optional)

Ipv6Prefix Up

string (optional)

L2EndpointRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
id (optional)
String The UUID of the port
name (optional)
String The name of the endpoint
innerTag (optional)
Integer The inner tag. Applicable to Dot1Q or QinQ ports.
isHub (optional)
Boolean Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service.
outerTag (optional)
Integer The outer tag. Applicable to Dot1Q or QinQ ports.
siteServiceQosProfile (optional)
SiteServiceQosProfile The name of Generic QoS profile applied to the endpoint

L3EndpointRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
id (optional)
String The UUID of the port
name (optional)
String The name of the endpoint
innerTag (optional)
Integer The inner tag. Applicable to Dot1Q or QinQ ports.
isHub (optional)
Boolean Specifies whether or not the service endpoint is a hub for a hub-and-spoke topology. This influences the automatic route-target and route-distinguisher generation for L3 VPRN service.
outerTag (optional)
Integer The outer tag. Applicable to Dot1Q or QinQ ports.
siteServiceQosProfile (optional)
SiteServiceQosProfile The name of Generic QoS profile applied to the endpoint
primaryAddress (optional)
IpPrefix The primary IP address assigned to the service endpoint
rd (optional)
String The route distinguisher for the service endpoint
routeTargets (optional)
routingBgp (optional)
RoutingBgp BGP specific configuration.
routingStatic (optional)
secondaryAddresses (optional)
array[IpPrefix] A list of secondary IP addresses assigned to the service endpoint

L3vpnRdRtPolicy Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
maxAssignedForRd (optional)
Long Maximum assigned number for route distinguisher. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
maxAssignedForRt (optional)
Long The maximum value that can be assigned for the route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
minAssignedForRd (optional)
Long The minimum value that can be assigned for the route distinguisher. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
minAssignedForRt (optional)
Long The minimum value that can be assigned for the route target. For type 0, the value must be between 0 and 4294967295, inclusive. For Type 2, the value must be between 0 and 65535, inclusive
networkASForRd (optional)
Boolean Specifies whether or not the network AS number will be used for the route distinguisher
networkASForRt (optional)
Boolean Specifies whether or not the network AS number will be used for the route target
rdAS (optional)
Long The customer-specified AS number for the route distinguisher. For type 0, the value must be between 1 and 65535, inclusive. For Type 2, the value must be between 1 and 4294967295, inclusive. When the policy is configured using the network AS number, this value is not checked
rdType (optional)
Integer The route distinguisher type. The value can be 0/1/2. When the policy is configured using the network AS number, this value is not checked
rtAS (optional)
Long The customer-specified AS number for the route target. For type 0, the value must be between 0 and 65535, inclusive. For Type 2, the value must be between 0 and 4294967295, inclusive. When the policy is configured using the network AS number, this value is not checked
rtType (optional)
Integer The route target. The value can be 0/1/2. When the policy is configured using the network AS number, this value is not checked

L3vpnServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service
Enum:
MAINTENANCE
DOWN
UP
autobind (optional)
String The type of autobind to be used for the service
Enum:
rsvp_te
ldp
gre
none
mtu (optional)
Long The MTU for the service. The valid values are 0 (which means to use the port's MTU) or between 512 and 9000. Applied to all endpoints.
qosId (optional)
String The ID of the default QoS template associated with the service
qosName (optional)
String The name of the default QoS template associated with the service
tunnelSelectionId (optional)
String The ID of the Tunnel Selection template associated with the service

LabelRestriction Up

inclusiveExclusive (optional)
String Whether the list item is inclusive or exclusive.
Enum:
inclusive
exclusive
labelEnd (optional)
GeneralizedLabel The ending lable if a lable range is specified; This attribute is not set, If a single lable is specified.
labelStart (optional)
GeneralizedLabel This is the starting lable if a lable range is specified. This is the lable value if a single lable is specified, in which case, attribute 'label-end' is not set.
rangeBitmap (optional)
array[byte[]] When there are gaps between label-start and label-end, this attribute is used to specified the possitions of the used labels.

Lag Up

lagId (optional)
Integer The Id of this LAG
lagMembers (optional)

LagMemberInfo Up

bandwidth (optional)
Long The bandwidth of the LAG member
id (optional)
String The unique identifier of the LAG member
name (optional)
String The name of the LAG member

LagRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
action (optional)
String Specifies the action to perform on the service
Enum:
TRACE
DISCOVER
UPDATE
TRAVERSE
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
destinations (optional)
array[String] A list of destination service endpoints
encryption (optional)
Boolean Specifies whether the service should be encrypted or not. The service will be rejected if no path can be found which does not support encryption.
excludeRouteObject (optional)
facility (optional)
Integer Specifies the port facility number to be used for the OCH service. The value can be 1, or 2 for 260SCX2 L port in 200G mode
includeRouteObject (optional)
lambda (optional)
Double Unsupported - Specifies the lambda to be used for the service
modulation (optional)
String Specifies the modulation scheme for the optical signal
Enum:
MOD_SP_QPSK
MOD_QPSK
MOD_8QAM
MOD_16QAM
MOD_BPSK
phaseEncoding (optional)
String Specifies the encoding type of the optical signal
Enum:
absolute
differential
protection (optional)
Boolean Unsupported - Specifies whether a protection path should be created
protectionExcludeRouteObject (optional)
protectionIncludeRouteObject (optional)
protectionType (optional)
String Specifies the provisioned protection type of the connection. Only UNPROTECTED/OPSB/YCABLE are supported for ODU service and UNPROTECTED/OPSA are supported for OCH service.
Enum:
SERVER_PROTECTED
NA
OPSB
UNPROTECTED
OPSA
YCABLE
PROTECTED
OMSP
SNCP
regeneration (optional)
Boolean Specifies whether the service is permitted over a network element which performs optical regeneration
restoration (optional)
String Specifies the recovery technique of a path after failure.
Enum:
SBR
GR
None
reversionMode (optional)
String Specifies how the path switches from the recovery to the the working path previously under failure condition.
Enum:
softauto
auto
manual
sources (optional)
array[String] A list of source service endpoints
waveshape (optional)
String Specifies the shape of the optical signal to be used
Enum:
single
_super
alien
monitorBandwidth (optional)
Boolean Specifies whether or not the bandwidth utilization of the service will be monitored

LagServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
bandwidth (optional)
Long Specifies the bandwidth required for LAG service creation
monitorBandwidth (optional)
Boolean Specifies whether or not the service bandwidth should be monitored
reverseBandwidth (optional)
Long Specifies the reverse bandwidth required for LAG service creation

LifeCycle Up

phase (optional)
String The phase of the life cycle object
Enum:
Deployment
Activation
Planning
reason (optional)
String The reason for the current phase/state of the life cycle object
state (optional)
String The state of the life cycle object
Enum:
Delete
DeploymentFailed
PartiallyDeployed
WaitingForDeployment
Deploying
RoutedAndSaved
Undeployed
RoutingFailed
Routing
Undeploy
Deployed
Planned

Link Up

destination (optional)
Destination This container holds the logical destination of a particular link.
source (optional)
Source This container holds the logical source of a particular link.
supportingLink (optional)
linkId (optional)
LinkId The identifier of a link in the topology. A link is specific to a topology to which it belongs.
teLinkAugment (optional)
TeLinkAugment Augmentation for TE link.

LinkCost Up

latency (optional)
Double The latency of the physical link in microseconds

LinkId Up

uri (optional)

LinkTemplate Up

teLinkConfigAttributes (optional)
templateAttributes (optional)
name (optional)
TeTemplateName The name to identify a TE link template.
template (optional)

LldpConfigurationInfo Up

administrativeStatus (optional)
String The LLDP administrative status for the port
Enum:
DISABLED
TX_ONLY
TX_AND_RX
RX_ONLY
configurationType (optional)
String Whether this configuration is for Nearest Bridge, Nearest Customer, or Nearest Non TPMR
Enum:
NEAREST_NON_TPMR
NEAREST_CUSTOMER
NEAREST_BRIDGE

LldpRemotePeerInfo Up

capabilitiesEnabled (optional)
Long The capabilities that are enabled on the remote port
capabilitiesSupported (optional)
Long The capabilities the remote port supports
portDescription (optional)
String The description of the remote port
remoteChassisId (optional)
String A string identifying the remote chassis
remoteChassisIdType (optional)
String The remote chassis id type
Enum:
INTERFACE_ALIAS
INTERFACE_NAME
SUBNET
NETWORK_ADDRESS
LOCAL
PORT_COMPONENT
CHASSIS_COMPONENT
MAC_ADDRESS
remoteIndex (optional)
Long The remote peer index
remoteManagementIpAddress (optional)
remotePeerType (optional)
String The remote peer type
Enum:
NEAREST_NON_TPMR
NEAREST_CUSTOMER
NEAREST_BRIDGE
remotePortId (optional)
String A string identifying the remote port
remotePortIdType (optional)
String The remote port id type
Enum:
INTERFACE_ALIAS
INTERFACE_NAME
NETWORK_ADDRESS
LOCAL
PORT_COMPONENT
AGENT_CIRCUIT_ID
MAC_ADDRESS
remoteSystemName (optional)
String The name of the remote system

LoopbackEndpointRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
id (optional)
String The UUID of the port
name (optional)
String The name of the endpoint
primaryAddress (optional)
IpPrefix The primary IP address assigned to the service loopBack endpoint

LspEncodingTypes Up

LspProtType Up

Measurement Up

performanceMetricAttributes (optional)
PerformanceMetricAttributes Link performance information in real time.

MonitoredPort Up

externalId (optional)
String The external ID of the port
id (optional)
String The unique identifier for the monitored port
lastThresholdCrossed (optional)
Long Last threshold level crossed
lastThresholdCrossedTimestamp (optional)
DateAndTime Timestamp of last threshold level crossed
monitoredRouterId (optional)
String The unique identifier of the monitored router for this port
name (optional)
String The port name
neId (optional)
String The unique identifier for the corresponding network element router
nextHopBundleId (optional)
String The unique identifier of the next hop bundle
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
nextHopRouterIpAddress (optional)
IpAddress The bundle's next hop's router IP address
portCapacity (optional)
Long Port capacity
portId (optional)
String The unique identifier for the corresponding network element port
routerIpAddress (optional)
IpAddress The IP address of the router for this port
utilization (optional)
Long Port utilization as a percentage

MonitoredPortRequest Up

nextHopBundleId (optional)
String The unique identifier of the next hop bundle
portId (optional)
String The unique identifier for the network element port

MonitoredRouter Up

asDatapathId (optional)
String The datapath ID of the OF switch used for AS steering
asTableId (optional)
Integer The table ID of the OF Switch used for AS steering
externalId (optional)
String The external ID of the router
highUtilizationPortCount (optional)
Long The number of monitored ports with high utilization
id (optional)
String The unique identifier for the monitored router
monitoredPortCount (optional)
Long The number of monitored ports on this router
name (optional)
String The name of the router
neId (optional)
String The unique identifier for the corresponding network element router
routerIpAddress (optional)
IpAddress The IP address of the router
steeredAsCount (optional)
Long The number of AS steered on this router
steeredVipCustomerCount (optional)
Long The number of VIP customers steered on this router
vipDatapathId (optional)
String The datapath ID of the OF switch used for VIP steering
vipTableId (optional)
Integer The table ID of the OF Switch used for VIP steering

MonitoredRouterModifyRequest Up

asDatapathId (optional)
String The datapath ID of the OF switch to use for AS steering
asTableId (optional)
Integer The table-id of the OF Switch to use for AS steering
vipDatapathId (optional)
String The datapath ID of the OF switch to use for VIP steering
vipTableId (optional)
Integer The table ID of the OF Switch to use for VIP steering

MonitoredRouterRequest Up

asDatapathId (optional)
String The datapath ID of the OF switch to use for AS steering
asTableId (optional)
Integer The table-id of the OF Switch to use for AS steering
neId (optional)
String The unique identifier for the network element router
vipDatapathId (optional)
String The datapath ID of the OF switch to use for VIP steering
vipTableId (optional)
Integer The table ID of the OF Switch to use for VIP steering

Network Up

networkTypes (optional)
NetworkTypes Serves as an augmentation target. The network type is indicated through corresponding presence containers augmented into this container.
node (optional)
supportingNetwork (optional)
networkId (optional)
NetworkId Identifies a network.

NetworkElement Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
baseMacAddress (optional)
String The base MAC address for the network element
customProperties (optional)
array[String] The custom properties of the network element
geoLocation (optional)
GeoLocation The location of the network element site
ipAddress (optional)
String The IP address of the network element
location (optional)
String The name of the site where the network element is located
platform (optional)
Platform Contains vendor-specific information for identifying the system platform and operating system.
siteName (optional)
String The name of the network element site

NetworkElementRequest Up

l3vpnCapable (optional)
Boolean Specifies whether or not the network element is l3vpn capable
pwSwitchingCapable (optional)
Boolean Specifies whether or not the network element is pseudowire switching capable. Defaults to false

NetworkId Up

uri (optional)

NetworkIdentifierType Up

uint32 (optional)

NetworkTypes Up

Networks Up

network (optional)
teTopologiesAugment (optional)
TeTopologiesAugment Augmentation for TE topologies.

NextHopBundle Up

id (optional)
String The unique identifier for the bundle
name (optional)
String The name of the bundle
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
nextHopRouterIpAddress (optional)
IpAddress The bundle's next hop's router IP address

NextHopBundleModifyRequest Up

isVip (optional)
Boolean Indicates this bundle is for VIP steering
name (optional)
String The name of the bundle

NextHopBundleRequest Up

isVip (optional)
Boolean Indicates this bundle is for VIP steering
name (optional)
String The name of the bundle
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
nextHopRouterIpAddress (optional)
IpAddress The bundle's next hop's router IP address

NextHopBundleSearch Up

nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop

Node Up

supportingNode (optional)
nodeId (optional)
NodeId Identifies a node uniquely within the containing network.
terminationPoint (optional)
teNodeAugment (optional)
TeNodeAugment Augmentation for TE node.

NodeId Up

uri (optional)

NodeTemplate Up

teNodeConfigAttributesTemplate (optional)
templateAttributes (optional)
name (optional)
TeTemplateName The name to identify a TE node template.
template (optional)

Normality Up

performanceMetricNormalityAttributes (optional)
PerformanceMetricNormalityAttributes Link performance metric normality attributes.

NspOpticsExplicitRoute Up

asNumber (optional)
Integer AS number
v4Address (optional)
Ipv4Address An IPv4 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.
v4Loose (optional)
Boolean Describes whether the object is loose if set, or otherwise strict
v4PrefixLength (optional)
Integer Length in bits of the IPv4 prefix
value (optional)
Long the label value
interfaceId (optional)
Long The interface identifier
routerId (optional)
IpAddress A router-id address
v6Address (optional)
Ipv6Address An IPv6 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.
v6Loose (optional)
Boolean Describes whether the object is loose if set, or otherwise strict
v6PrefixLength (optional)
Integer Length in bits of the IPv4 prefix
linkId (optional)
String The identifier for the link.
linkLoose (optional)
Boolean Specifies if this contraint is strict or loose.
srlgLoose (optional)
Boolean Specifies if this constraint is strict or loose
srlgs (optional)
array[Long] The srlg value
regenInterfaceIds (optional)
array[String] The regen interface identifiers
regenLoose (optional)
Boolean Specifies if this constraint is strict or loose
regenRouterId (optional)
Ipv4Address A router-id address

NspToken Up

expires (optional)
Long Specifies the expiry date of the token in milliseconds since January 1, 1970, 00:00:00 GMT
id (optional)
String Specifies the identifier of the token

OchServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
restoration (optional)
String Specifies the recovery technique of a path after failure.
Enum:
SBR
GR
None
reversionMode (optional)
String Specifies how the path switches from the recovery to the the working path previously under failure condition.
Enum:
softauto
auto
manual

OduServiceCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
maxCost (optional)
Double The maximum cost. The value must be greater than or equal to 0.
maxHops (optional)
Integer The maximum hops. The value must be greater than or equal to 0.
maxLatency (optional)
Double The maximum latency. The value must be greater than or equal to 0.
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
bandwidth (optional)
Long Specifies the bandwidth required for ODU creation
reverseBandwidth (optional)
Long Specifies the reverse bandwidth required for ODU creation

OpenflowAction Up

actionType (optional)
String Type of the action
Enum:
OUT_PORT
EXPERIMENTER
experimenterActionType (optional)
String Type of the experimenter action. Applicable only for experimenter actions
Enum:
REDIRECT_TO_NEXTHOP
REDIRECT_TO_SVCT
ipAddress (optional)
IpAddress Next Hop IP address
portId (optional)
Long Openflow switch output port id
sdpId (optional)
Long SDP id
vcId (optional)
Long Virtual circuit id

OpenflowFlowEntry Up

applicationGroupId (optional)
Long The identification of the application group, used by the application to categorize this flow
applicationId (optional)
Integer The identification of the application which deployed the flow, negative numbers are reserved and should not be used
auditstate (optional)
String The audit state of the flow
Enum:
SUCCESS
NOT_DONE
FAILURE
cookie (optional)
String The hexadecimal controller issued identifier for this flow
datapathId (optional)
String The hexadecimal openflow data-path id for this switch
flowId (optional)
String The unique identifier of the flow, this is auto generated on the server
lifecycle (optional)
String The lifecycle of the flow
Enum:
PENDING_DELETE
DEPLOYED
NO_ACTION
DELETED
PENDING_CREATE
PENDING_MODIFICATION
openflowInstruction (optional)
OpenflowInstruction The instruction to be performed on the flow
openflowMatch (optional)
OpenflowMatch The match criteria for this flow
priority (optional)
Long The priority of the flow
tableId (optional)
Long The table id number within the switch

OpenflowFlowEntryRequest Up

applicationGroupId (optional)
Long The identification of the application group, used by the application to categorize this flow
applicationId (optional)
Integer The identification of the application which deployed the flow, negative numbers are reserved and should not be used
cookie (optional)
String The hexadecimal controller issued identifier for this flow
datapathId (optional)
String The hexadecimal openflow data-path id for this switch
openflowInstruction (optional)
OpenflowInstruction The instruction to be performed on the flow
openflowMatch (optional)
OpenflowMatch The match criteria for this flow
priority (optional)
Long The priority of the flow
tableId (optional)
Long The table id number within the switch

OpenflowFlowSearch Up

applicationGroupId (optional)
Long The identification of the application group, used by the application to categorize this flow
applicationId (optional)
Integer The identification number of the application which deployed the flow
cookie (optional)
String The hexadecimal identifier or its prefix for the flow
datapathId (optional)
String The hexadecimal openflow data-path id for this switch
headerOnly (optional)
Boolean To control whether to fetch only flow headers or complete flow details
openflowMatch (optional)
OpenflowMatch The match criteria for this flow
priority (optional)
Long The priority of the flow
tableId (optional)
Long The table id number within the switch

OpenflowFlowSearchById Up

flowIds (optional)
array[String] List of flows' unique identifers

OpenflowInstruction Up

actions (optional)
instructionType (optional)
String Type of the instruction
Enum:
CLEAR_ACTIONS
APPLY_ACTIONS
WRITE_ACTIONS

OpenflowMatch Up

destIpAddress (optional)
IpPrefix Destination IP address/mask
destPort (optional)
Long Destination (TCP or UDP) port number
ethernetType (optional)
String Ethernet Type in hexadecimal (for example 0x800 for IPv4)
ipProtocolType (optional)
Integer IP Protocol Type (for example 6 for TCP or 17 for UDP)
sourceIpAddress (optional)
IpPrefix Source IP address/mask
sourcePort (optional)
Long Source (TCP or UDP) port number

OpenflowPort Up

datapathId (optional)
String The hexadecimal openflow data-path id for this switch
hardwareAddress (optional)
String The hardware address of the port
portId (optional)
Long The port id which identifies the port
portName (optional)
String The name of the port

OpenflowSwitch Up

datapathId (optional)
String The hexadecimal openflow data-path id for this switch
maxTables (optional)
Long Maximum number of tables supported on this switch
numberOfBuffers (optional)
Long Maximum number of buffers supported on this switch
openflowVersion (optional)
String The openflow protocol version for this switch
Enum:
V140
V150
V10
V200
V131
V130
serialNumber (optional)
String Serial number of this switch
status (optional)
String Status of this switch
Enum:
DOWN
ACTIVE
UNKNOWN
swDescription (optional)
String Description of this switch
switchAddress (optional)
IpAddress The ip address of this switch
vendorType (optional)
String Vendor of this switch
Enum:
OTHER
NOKIA
ALCATEL

OpenflowTable Up

datapathId (optional)
String The hexadecimal openflow data-path id for this switch
maxEntries (optional)
Long The number of entries the table supports
tableId (optional)
Long The table id number within the switch

Optics Up

protectionType (optional)
String Specifies the protection type of the port
Enum:
working
protection

OpticsRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
action (optional)
String Specifies the action to perform on the service
Enum:
TRACE
DISCOVER
UPDATE
TRAVERSE
bidirectional (optional)
String Specifies whether a return path is required, and if so what type of return path should be determined. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String Specifies the name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceId (optional)
String Specifies the identifier of the service. Mandatory for a modify request.
templateId (optional)
String Specifies the identifier of the template to apply to the service. The values specified in the request will override the values defined in the template.
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
destinations (optional)
array[String] A list of destination service endpoints
encryption (optional)
Boolean Specifies whether the service should be encrypted or not. The service will be rejected if no path can be found which does not support encryption.
excludeRouteObject (optional)
facility (optional)
Integer Specifies the port facility number to be used for the OCH service. The value can be 1, or 2 for 260SCX2 L port in 200G mode
includeRouteObject (optional)
lambda (optional)
Double Unsupported - Specifies the lambda to be used for the service
modulation (optional)
String Specifies the modulation scheme for the optical signal
Enum:
MOD_SP_QPSK
MOD_QPSK
MOD_8QAM
MOD_16QAM
MOD_BPSK
phaseEncoding (optional)
String Specifies the encoding type of the optical signal
Enum:
absolute
differential
protection (optional)
Boolean Unsupported - Specifies whether a protection path should be created
protectionExcludeRouteObject (optional)
protectionIncludeRouteObject (optional)
protectionType (optional)
String Specifies the provisioned protection type of the connection. Only UNPROTECTED/OPSB/YCABLE are supported for ODU service and UNPROTECTED/OPSA are supported for OCH service.
Enum:
SERVER_PROTECTED
NA
OPSB
UNPROTECTED
OPSA
YCABLE
PROTECTED
OMSP
SNCP
regeneration (optional)
Boolean Specifies whether the service is permitted over a network element which performs optical regeneration
restoration (optional)
String Specifies the recovery technique of a path after failure.
Enum:
SBR
GR
None
reversionMode (optional)
String Specifies how the path switches from the recovery to the the working path previously under failure condition.
Enum:
softauto
auto
manual
sources (optional)
array[String] A list of source service endpoints
waveshape (optional)
String Specifies the shape of the optical signal to be used
Enum:
single
_super
alien

Ownership Up

consumable (optional)
Boolean Whether the system is able to consume this resource
deletable (optional)
Boolean Whether the system is able to delete this resource automatically due to a change at a higher or lower layer
modifiable (optional)
Boolean Whether the system is able to modify this resource automatically due to a change at a higher or lower layer

PathProfileTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
bidirection (optional)
String The Bidirectional Mode to be used in path computation
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
disjoint (optional)
String The Disjoint Mode to be used in path computation
Enum:
NO
NODE_STRICT_AND_SRLG
LINK_LOOSE
LINK_STRICT_AND_SRLG
NODE_STRICT
NODE_LOOSE
LINK_STRICT
maxCost (optional)
Long The Max Cost constraint to be used in path computation
maxHops (optional)
Long The Max Hops constraint to be used in path computation
maxTeMetric (optional)
Long The Max TE Metric constraint to be used in the path computation
objective (optional)
String The Metric Objective to be used in path computation
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
profileId (optional)
Long The Profile ID of the paths to be included in path computation. NOTE: A profile with Profile ID = 0 is a global default profile that applies to ALL paths that have NO specified Profile ID. The global default profile does NOT support BiDirectional or Disjoint properties

PerformanceMetric Up

measurement (optional)
Measurement Measured performance metric values. Static configuration and manual overrides of these measurements are also allowed.
normality (optional)
Normality Performance metric normality values.
tePerformanceMetric (optional)

PerformanceMetricAttributes Up

unidirectionalAvailableBandwidth (optional)
Double Available bandwidth that is defined to be residual bandwidth minus the measured bandwidth used for the actual forwarding of non-RSVP-TE LSP packets. For a bundled link, available bandwidth is defined to be the sum of the component link available bandwidths.
unidirectionalDelay (optional)
Long Delay or latency in micro seconds.
unidirectionalDelayVariation (optional)
Long Delay variation in micro seconds.
unidirectionalMaxDelay (optional)
Long Maximum delay or latency in micro seconds.
unidirectionalMinDelay (optional)
Long Minimum delay or latency in micro seconds.
unidirectionalPacketLoss (optional)
Double Packet loss as a percentage of the total traffic sent over a configurable interval. The finest precision is 0.000003%.
unidirectionalResidualBandwidth (optional)
Double Residual bandwidth that subtracts tunnel reservations from Maximum Bandwidth (or link capacity) [RFC3630] and provides an aggregated remainder across QoS classes.
unidirectionalUtilizedBandwidth (optional)
Double Bandwidth utilization that represents the actual utilization of the link (i.e. as measured in the router). For a bundled link, bandwidth utilization is defined to be the sum of the component link bandwidth utilizations.

PerformanceMetricNormalityAttributes Up

unidirectionalAvailableBandwidth (optional)
String Available bandwidth normality.
Enum:
normal
abnormal
unknown
unidirectionalDelay (optional)
String Delay normality.
Enum:
normal
abnormal
unknown
unidirectionalDelayVariation (optional)
String Delay variation normality.
Enum:
normal
abnormal
unknown
unidirectionalMaxDelay (optional)
String Maximum delay or latency normality.
Enum:
normal
abnormal
unknown
unidirectionalMinDelay (optional)
String Minimum delay or latency normality.
Enum:
normal
abnormal
unknown
unidirectionalPacketLoss (optional)
String Packet loss normality.
Enum:
normal
abnormal
unknown
unidirectionalResidualBandwidth (optional)
String Residual bandwidth normality.
Enum:
normal
abnormal
unknown
unidirectionalUtilizedBandwidth (optional)
String Bandwidth utilization normality.
Enum:
normal
abnormal
unknown

PerformanceMetricThrottle Up

advertisementInterval (optional)
Long Interval in seconds to advertise the extended metric values.
measureInterval (optional)
Long Interval in seconds to measure the extended metric values.
suppressionInterval (optional)
Long Interval in seconds to suppress advertising the extended metric values.
tePerformanceMetric (optional)
thresholdAcceleratedAdvertisement (optional)
ThresholdAcceleratedAdvertisement When the difference between the last advertised value and current measured value exceed this threshold, anomalous announcement will be triggered.
thresholdIn (optional)
ThresholdIn If the measured parameter falls inside an upper bound for all but the min delay metric (or lower bound for min-delay metric only) and the advertised value is not already inside that bound, normal (anomalous-flag cleared) announcement will be triggered.
thresholdOut (optional)
ThresholdOut If the measured parameter falls outside an upper bound for all but the min delay metric (or lower bound for min-delay metric only) and the advertised value is not already outside that bound, anomalous announcement will be triggered.
unidirectionalDelayOffset (optional)
Long Offset value to be added to the measured delay value.

PerformanceMetricThrottleContainer Up

performanceMetricThrottle (optional)
PerformanceMetricThrottle Link performance information in real time.

PhysicalLink Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
destinationId (optional)
String The id of the destination network element
destinationPortId (optional)
String The id of the destination NNI port
linkCost (optional)
sourceId (optional)
String The id of the source network element
sourcePortId (optional)
String The id of the source NNI port

Platform Up

machine (optional)
String A vendor-specific identifier string representing the hardware in use.
osName (optional)
String Unsupported - The name of the operating system in use - for example, 'Linux'.
osRelease (optional)
String Unsupported - The current release level of the operating system in use. This string MAY indicate the OS source code revision.
osVersion (optional)
String The current version level of the operating system in use. This string MAY indicate the specific OS build date and target variant information.

Port Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
availableEgressBandwidth (optional)
Long Specifies the available egress bandwidth associated with a port
availableIngressBandwidth (optional)
Long Specifies the available ingress bandwidth associated with a port
ethernet (optional)
Ethernet Contains all Ethernet interface related configuration
interfaceId (optional)
Long The id of the port/interface
name (optional)
String The name of the port
neId (optional)
String The router entity where the port resides
neName (optional)
String The name of the network equipment to which this endpoint belongs
optics (optional)
Optics Contains Optical related configuration
portSpeed (optional)
Long The interface speed of the port
portType (optional)
String The type of port. Supported values are defined in RFC7224
role (optional)
String Whether the port is a UNI or NNI port
Enum:
UNI
NNI
tdm (optional)
Tdm Contains TDM DS1/E1 interface related configuration

PortRequest Up

protectionType (optional)
String Specifies the protection type of the port. This only applies to client optical ports.
Enum:
working
protection

PortUtilizationHistory Up

timestamp (optional)
DateAndTime Date and time-stamp for this record
utilization (optional)
Double Port utilization as a percentage

QosProfile Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
egressCosMappingTable (optional)
egressParam (optional)
EgressParam Egress QoS related parameters.
egressQueueConfigurationTable (optional)
externalIds (optional)
ingressCosMappingTable (optional)
ingressParam (optional)
IngressParam Ingress QoS related parameters.
ingressQueueConfigurationTable (optional)

QosTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
egressParam (optional)
EgressParam Egress QoS override parameters.
egressQueueOverride (optional)
ingressParam (optional)
IngressParam Ingress QoS override parameters.
ingressQueueOverride (optional)
qosProfile (optional)
Long The ID of the default Generic QoS profile associated with the quality of service template

Queue Up

cbs (optional)
Long The Committed Burst Size in KB.
cir (optional)
Long The Committed Information Rate in either Kbps or percentage (0..100). Default value, no override: set to -2; Max rate available: set to -1
id (optional)
Long ID of the queue
mbs (optional)
Long The Maximum Burst Size in KB.
pir (optional)
Long The Peak Information Rate in either Kbps or percentage (1..100). Default value, no override: set to -2; Max rate available: set to -1
queueType (optional)
String The type of the queue override. Default is Queue.
Enum:
Policer
Queue
rateType (optional)
String The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the queue rate will be a percentage of the port rate
Enum:
kbps
percent

Recovery Up

protectionStatus (optional)
String Protection status.
Enum:
reversion_failed
normal
reversion_started
recovery_unavailable
recovery_admin
recovery_succeeded
recovery_failed
recovery_started
wait_to_restore
restorationStatus (optional)
String Restoration status.
Enum:
reversion_failed
normal
reversion_started
recovery_unavailable
recovery_admin
recovery_succeeded
recovery_failed
recovery_started
wait_to_restore

Request«AsEntryRequest» Up

data (optional)

Request«AsSteeringEntryRequest» Up

data (optional)

Request«ClineServiceCreationTemplate» Up

data (optional)

Request«ClineServiceRequest» Up

data (optional)

Request«CustomAttributesTemplate» Up

data (optional)

Request«ElanServiceCreationTemplate» Up

data (optional)

Request«ElineRequestData» Up

data (optional)

Request«ElineServiceCreationTemplate» Up

data (optional)

Request«ExternalId» Up

data (optional)

Request«IpElanServiceRequest» Up

data (optional)

Request«IpL3ServiceRequest» Up

data (optional)

Request«L2EndpointRequest» Up

data (optional)

Request«L3EndpointRequest» Up

data (optional)

Request«L3vpnRdRtPolicy» Up

data (optional)

Request«L3vpnServiceCreationTemplate» Up

data (optional)

Request«LagRequest» Up

data (optional)

Request«LagServiceCreationTemplate» Up

data (optional)

Request«List«MonitoredPortRequest»» Up

data (optional)

Request«List«OpenflowFlowEntryRequest»» Up

data (optional)

Request«List«VipSubnetEntryRequest»» Up

data (optional)

Request«List«VipSubnetSteeringEntryRequest»» Up

data (optional)

Request«List«string»» Up

data (optional)

Request«LoopbackEndpointRequest» Up

data (optional)

Request«MonitoredRouterModifyRequest» Up

data (optional)

Request«MonitoredRouterRequest» Up

data (optional)

Request«NetworkElementRequest» Up

data (optional)

Request«NextHopBundleModifyRequest» Up

data (optional)

Request«NextHopBundleRequest» Up

data (optional)

Request«NextHopBundleSearch» Up

data (optional)

Request«OchServiceCreationTemplate» Up

data (optional)

Request«OduServiceCreationTemplate» Up

data (optional)

Request«OpenflowFlowSearchById» Up

data (optional)

Request«OpenflowFlowSearch» Up

data (optional)

Request«OpticsRequest» Up

data (optional)

Request«PathProfileTemplate» Up

data (optional)

Request«PortRequest» Up

data (optional)

Request«QosTemplate» Up

data (optional)

Request«RouterIdSystemIdMapping» Up

data (optional)

Request«ServiceTunnelRequest» Up

data (optional)

Request«SteeringEntrySearch» Up

data (optional)

Request«SteeringParameter» Up

data (optional)

Request«TdmEndpointRequest» Up

data (optional)

Request«Tenant» Up

data (optional)

Request«TunnelCreationTemplate» Up

data (optional)

Request«TunnelSelectionTemplate» Up

data (optional)

Request«UserInfo» Up

data (optional)

Request«VipAllSubnetSteeringEntryRequest» Up

data (optional)

Request«VipCustomerEntryRequest» Up

data (optional)

Request«VipSubnetEntryRequest» Up

data (optional)

ResponseData«AsBw» Up

response (optional)

ResponseData«AsEntry» Up

response (optional)

ResponseData«AsSteeringEntry» Up

response (optional)

ResponseData«Authentication» Up

response (optional)

ResponseData«BaseEntity» Up

response (optional)

ResponseData«BaseService» Up

response (optional)

ResponseData«ClineServiceCreationTemplate» Up

response (optional)

ResponseData«CustomAttributesTemplate» Up

response (optional)

ResponseData«ElanServiceCreationTemplate» Up

response (optional)

ResponseData«ElineServiceCreationTemplate» Up

response (optional)

ResponseData«L3vpnServiceCreationTemplate» Up

response (optional)

ResponseData«LagServiceCreationTemplate» Up

response (optional)

ResponseData«Link» Up

response (optional)

ResponseData«List«AsBw»» Up

response (optional)

ResponseData«List«AsEntry»» Up

response (optional)

ResponseData«List«AsSteeringEntryDetail»» Up

response (optional)

ResponseData«List«AsSteeringEntry»» Up

response (optional)

ResponseData«List«AsSubnetEntry»» Up

response (optional)

ResponseData«List«BaseEntity»» Up

response (optional)

ResponseData«List«BaseServiceEndpoint»» Up

response (optional)

ResponseData«List«BaseService»» Up

response (optional)

ResponseData«List«ClineServiceCreationTemplate»» Up

response (optional)

ResponseData«List«CustomAttributesTemplate»» Up

response (optional)

ResponseData«List«ElanServiceCreationTemplate»» Up

response (optional)

ResponseData«List«ElineServiceCreationTemplate»» Up

response (optional)

ResponseData«List«L3vpnRdRtPolicy»» Up

response (optional)

ResponseData«List«L3vpnServiceCreationTemplate»» Up

response (optional)

ResponseData«List«LagServiceCreationTemplate»» Up

response (optional)

ResponseData«List«MonitoredPort»» Up

response (optional)

ResponseData«List«MonitoredRouter»» Up

response (optional)

ResponseData«List«NetworkElement»» Up

response (optional)

ResponseData«List«NextHopBundle»» Up

response (optional)

ResponseData«List«OchServiceCreationTemplate»» Up

response (optional)

ResponseData«List«OduServiceCreationTemplate»» Up

response (optional)

ResponseData«List«OpenflowFlowEntry»» Up

response (optional)

ResponseData«List«OpenflowPort»» Up

response (optional)

ResponseData«List«OpenflowSwitch»» Up

response (optional)

ResponseData«List«OpenflowTable»» Up

response (optional)

ResponseData«List«PathProfileTemplate»» Up

response (optional)

ResponseData«List«PhysicalLink»» Up

response (optional)

ResponseData«List«PortUtilizationHistory»» Up

response (optional)

ResponseData«List«Port»» Up

response (optional)

ResponseData«List«QosProfile»» Up

response (optional)

ResponseData«List«QosTemplate»» Up

response (optional)

ResponseData«List«RouterIdSystemIdMapping»» Up

response (optional)

ResponseData«List«ServiceTunnel»» Up

response (optional)

ResponseData«List«SteeringParameter»» Up

response (optional)

ResponseData«List«Tenant»» Up

response (optional)

ResponseData«List«TunnelCreationTemplate»» Up

response (optional)

ResponseData«List«TunnelSelectionTemplate»» Up

response (optional)

ResponseData«List«User»» Up

response (optional)

ResponseData«List«VipCustomerBwEntry»» Up

response (optional)

ResponseData«List«VipCustomerEntry»» Up

response (optional)

ResponseData«List«VipSteeringEntry»» Up

response (optional)

ResponseData«List«VipSubnetEntry»» Up

response (optional)

ResponseData«List«string»» Up

response (optional)

ResponseData«MonitoredPort» Up

response (optional)

ResponseData«MonitoredRouter» Up

response (optional)

ResponseData«NetworkElement» Up

response (optional)

ResponseData«Networks» Up

response (optional)

ResponseData«Network» Up

response (optional)

ResponseData«NextHopBundle» Up

response (optional)

ResponseData«Node» Up

response (optional)

ResponseData«NspToken» Up

response (optional)

ResponseData«OchServiceCreationTemplate» Up

response (optional)

ResponseData«OduServiceCreationTemplate» Up

response (optional)

ResponseData«PathProfileTemplate» Up

response (optional)

ResponseData«PhysicalLink» Up

response (optional)

ResponseData«Port» Up

response (optional)

ResponseData«QosProfile» Up

response (optional)

ResponseData«QosTemplate» Up

response (optional)

ResponseData«RouterIdSystemIdMapping» Up

response (optional)

ResponseData«ServiceTunnel» Up

response (optional)

ResponseData«SteeringParameter» Up

response (optional)

ResponseData«Tenant» Up

response (optional)

ResponseData«TerminationPoint» Up

response (optional)

ResponseData«TunnelSelectionTemplate» Up

response (optional)

ResponseData«User» Up

response (optional)

ResponseData«VipCustomerAndSubnetBwEntry» Up

response (optional)

ResponseData«VipCustomerEntry» Up

response (optional)

ResponseData«VipSteeringEntry» Up

response (optional)

ResponseData«boolean» Up

response (optional)

ResponseData«long» Up

response (optional)

ResponseData«string» Up

response (optional)

Response«AsBw» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«AsEntry» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«AsSteeringEntry» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Authentication» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«BaseEntity» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«BaseService» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«ClineServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«CustomAttributesTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«ElanServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«ElineServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«ErrorMessages» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«L3vpnServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«LagServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Link» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«AsBw»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«AsEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«AsSteeringEntryDetail»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«AsSteeringEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«AsSubnetEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«BaseEntity»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«BaseServiceEndpoint»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«BaseService»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«ClineServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«CustomAttributesTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«ElanServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«ElineServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«L3vpnRdRtPolicy»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«L3vpnServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«LagServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«MonitoredPort»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«MonitoredRouter»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«NetworkElement»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«NextHopBundle»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«OchServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«OduServiceCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«OpenflowFlowEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«OpenflowPort»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«OpenflowSwitch»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«OpenflowTable»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«PathProfileTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«PhysicalLink»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«PortUtilizationHistory»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«Port»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«QosProfile»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«QosTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«RouterIdSystemIdMapping»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«ServiceTunnel»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«SteeringParameter»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«Tenant»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«TunnelCreationTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«TunnelSelectionTemplate»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«User»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«VipCustomerBwEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«VipCustomerEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«VipSteeringEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«VipSubnetEntry»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«List«string»» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«MonitoredPort» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«MonitoredRouter» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«NetworkElement» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Networks» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Network» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«NextHopBundle» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Node» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«NspToken» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«OchServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«OduServiceCreationTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«PathProfileTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«PhysicalLink» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Port» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«QosProfile» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«QosTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«RouterIdSystemIdMapping» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«ServiceTunnel» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«SteeringParameter» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«Tenant» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«TerminationPoint» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«TunnelSelectionTemplate» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«User» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«VipCustomerAndSubnetBwEntry» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«VipCustomerEntry» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«VipSteeringEntry» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«boolean» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«long» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

Response«string» Up

status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)

RouteTarget Up

rt (optional)
String The route target for the service
targetType (optional)
String The type of route target that is defined for the service. Can be either import or export
Enum:
import_export
exp
imp

RouterIdSystemIdMapping Up

systemId (optional)
IpAddress The system address.
systemName (optional)
String The system name.
appId (optional)
String The client-defined custom Application ID for this object
name (optional)
String The name of the template
pccAddress (optional)
IpAddress The PCC IP address.
routerInfos (optional)
id (optional)
String The unique identifier of the template
objectDescription (optional)
String The description for this object

RouterInfo Up

bgpLsId (optional)
Long BGP-LS topology identifier.
protocol (optional)
String The protocol which IGP router is using
Enum:
OSPFv2
ISIS
ANY
networkIdentifier (optional)
NetworkIdentifierType Network identifier.
routerId (optional)
DottedQuad The IGP Router ID.
asNumber (optional)
AsNumber Autonomous system number.

RoutingBgp Up

routes (optional)

RoutingStatic Up

routes (optional)

Schedule Up

repeatInterval (optional)
String Repeat interval in ISO 8601 format.
scheduleDuration (optional)
String Schedule duration in ISO 8601 format.
scheduleId (optional)
Long Identifies the schedule element.
start (optional)
DateAndTime Start time.

Scheduler Up

cir (optional)
Long Scheduler CIR override in either Kbps or percentage (0..100), where -3 is sum of CIR, -2 is no override, -1 is maximum
pir (optional)
Long Scheduler PIR override in either Kbps or percentage (1..100), where -2 is no override, -1 is maximum
rateType (optional)
String The type of the PIR/CIR rate. Default is Kbps. When set to percent, the value of the scheduler rate will be a percentage of the port rate
Enum:
kbps
percent
schedulerType (optional)
String The type of the scheduler override. Default is Scheduler.
Enum:
Scheduler
Arbiter

Schedules Up

schedules (optional)
SchedulesMember Container of a schedule list defining when a particular configuration takes effect.

SchedulesMember Up

schedule (optional)

ServiceEdge Up

endpointAId (optional)
String Specifies an endpoint upon which to terminate the service edge
endpointBId (optional)
String Specifies an endpoint upon which to terminate the service edge

ServiceTopology Up

edges (optional)
endpointGrouping (optional)
groupConnections (optional)
topoName (optional)
String The name of the topology

ServiceTunnel Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
externalIds (optional)
id (optional)
String The unique identifier of the entity
neDeploymentState (optional)
String The current deployment state of the entity
Enum:
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
bidirectional (optional)
String Specifies whether a return path is required, and if so, what type of return path will be used. Unsupported for L3 VPN Services
Enum:
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
bw (optional)
Long Specifies the bandwidth required for the service. Unsupported for IP Services
connectionState (optional)
String The connection state for the service
Enum:
DISCONNECTED
CONNECTED
UNKNOWN
endpoints (optional)
groupId (optional)
String Specifies the identifier of the group to which this service should belong. This only applies to optical services
lifeCycle (optional)
LifeCycle The Life Cycle details for a given object.
maxCost (optional)
Double Specifies the maximum cost to consider for the service. Unsupported for L3 VPN Services
maxHops (optional)
Integer Specifies the maximum number of hops to consider for the service. Unsupported for L3 VPN Services
maxLatency (optional)
Double Specifies the maximum latency (in ms) to consider for the service. Unsupported for IP Services
name (optional)
String The name of the service
objective (optional)
String Specifies the primary goal for identifying resources and/or paths for service creation. Unsupported for L3 VPN Services
Enum:
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
pathProfileId (optional)
String Specifies the identifier of the path profile to apply to the service. This only applies to optical services
reverseBW (optional)
Long Specifies the bandwidth required for the returning path of the service. Unsupported for IP Services
serviceType (optional)
String The type of the service
Enum:
ODU
TUNNEL
PHYSICAL_LINK
LAG
CLINE
ELAN
OCH
ELINE
L3_VPN
templateId (optional)
String Specifies the identifier of the template to apply to the service.
tenants (optional)
topology (optional)
String The logical topology of the service
tunnelSelectionId (optional)
String Specifies the identifier of the tunnel selection profile to apply to the service
availableBw (optional)
Long Specifies the available bandwidth on the service
destinationNodeId (optional)
IpAddress The destination node ID of the tunnel
ownership (optional)
Ownership Specifies ownership model of this tunnel
sourceNodeId (optional)
IpAddress The source node ID of the tunnel
steeringParameters (optional)
underlyingTransport (optional)
String The transport of the tunnel
Enum:
VXLAN
IPV4
L2TPV3
GRE
UNKNOWN
VLAN
ANY
MPLS

ServiceTunnelRequest Up

availableBw (optional)
Long Specifies the available bandwidth on the service
ownership (optional)
Ownership Specifies ownership model of this tunnel
steeringParameters (optional)

SiteServiceQosProfile Up

egressOverrideQueues (optional)
egressParam (optional)
EgressParam Egress Qos policy override parameters associated with an endpoint.
ingressOverrideQueues (optional)
ingressParam (optional)
IngressParam Ingress QoS policy override parameters associated with an endpoint.
qosProfile (optional)
Long The ID reference to the Generic QoS Profile

Source Up

sourceNode (optional)
String Source node identifier, must be in same topology.
sourceTp (optional)
String Termination point within source node that terminates the link.

Srlg Up

uint32 (optional)

State Up

teLinkConfig (optional)
TeLinkConfig TE link configuration grouping.
teLinkStateDerived (optional)
TeLinkStateDerived Link state attributes in a TE topology.

StaticRoute Up

destination (optional)
IpPrefix The prefix for the static route
preference (optional)
Long The preference of this static route. The default is 5 and the range is from 1 - 255
routeType (optional)
String Specifies the type of static route
Enum:
next_hop
targetIpAddress (optional)
IpAddress The target IP address. This would represent the next-hop address.

SteeringEntrySearch Up

nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop

SteeringParameter Up

name (optional)
UrlSafeString The name of the steering paramter

SupportingLink Up

linkRef (optional)
String This leaf identifies a link which is a part of this link's underlay. Reference loops in which a link identifies itself as its underlay, either directly or transitively, are not allowed.
networkRef (optional)
String This leaf identifies in which underlay topology the supporting link is present.

SupportingNode Up

networkRef (optional)
String References the underlay network that the underlay node is part of.
nodeRef (optional)
String References the underlay node itself.

SupportingTerminationPoint Up

networkRef (optional)
String This leaf identifies in which topology the supporting termination point is present.
nodeRef (optional)
String This leaf identifies in which node the supporting termination point is present.
tpRef (optional)
String Reference to the underlay node, must be in a different topology

SwitchingCapabilities Up

Tdm Up

channelFraming (optional)
String Specifies the channel framing configuration for the DS1/E1 port
ds0ChannelGroups (optional)
signalMode (optional)
Enum:
SIGNAL_MODE_CAS
SIGNAL_MODE_NONE

TdmDs0ChannelGroupInfo Up

adminState (optional)
String The current administrative state of this DS0 channel group
Enum:
MAINTENANCE
DOWN
UP
encapType (optional)
Enum:
PPP_AUTO
WAN_MIRROR
BCP_NULL
FRAME_RELAY
IPCP
BCP_DOT1Q
ATM
CEM
UNKNOWN
CISCO_HDLC
id (optional)
String The identifier of this DS0 channel group
name (optional)
String The name of this DS0 channel group
operationalState (optional)
String The current operational state of the DS0 channel group
Enum:
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
timeSlots (optional)
String The time-slots configured on the DS0 channel group

TdmEndpointRequest Up

adminState (optional)
String The current administrative state of the entity
Enum:
MAINTENANCE
DOWN
UP
appId (optional)
String The client-defined, custom Application ID for the entity
customAttributes (optional)
customAttributesTemplateId (optional)
String Specifies the identifier of the custom attributes template. The values specified in the request will override the values defined in the template.
readOnly (optional)
Boolean Specifies whether or not this request is read-only
tenantId (optional)
String Specifies the identifier of the tenant to which the service will be assigned. Additional Tenants may be assigned using the assign resources to tenant API
id (optional)
String The UUID of the port
name (optional)
String The name of the endpoint
siteServiceQosProfile (optional)
SiteServiceQosProfile The name of Generic QoS profile applied to the endpoint
timeSlots (optional)
String The time-slots configured on the DS0 channel group. The expected form is comma separated digits for individual time-slots with hyphen separated digits for a range of time-slots. E.g. \"3\" or \"3,5\" or \"3,5,8-12,20\" are all valid representations of time-slots

Te Up

config (optional)
Config Configuration data.
state (optional)
State Operational state data.

TeGlobalId Up

uint32 (optional)

TeLinkAttributes Up

accessType (optional)
String Link access type, which can be point-to-point or multi-access.
Enum:
point_to_point
multi_access
adminStatus (optional)
String The administrative state of the link.
Enum:
testing
up
preparing_maintenance
down
maintenance
externalDomain (optional)
ExternalDomain For an inter-domain link, specify the attributes of the remote end of link, to facilitate the signalling at local end.
isAbstract (optional)
Object Present if the link is abstract.
name (optional)
String Link Name.
performanceMetricThrottleContainer (optional)
PerformanceMetricThrottleContainer A container controlling performance metric throttle.
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
teLinkInfoAttributes (optional)
TeLinkInfoAttributes Advertised TE information attributes.
underlay (optional)
Underlay Attributes of the te-link underlay.

TeLinkAugment Up

te (optional)
Te Indicates TE support.

TeLinkConfig Up

teLinkAttributes (optional)
TeLinkAttributes Link attributes in a TE topology.
componentLinks (optional)
ComponentLinks A set of component links
bundledLinks (optional)
BundledLinks A set of bundled links.
teLinkTemplate (optional)
array[String] The reference to a TE link template.
template (optional)

TeLinkConfigAttributes Up

teLinkAttributes (optional)
TeLinkAttributes Link attributes in a TE topology.

TeLinkConnectivityAttributes Up

maxLinkBandwidth (optional)
Double Maximum bandwidth that can be seen on this link in this direction. Units in bytes per second.
maxResvLinkBandwidth (optional)
Double Maximum amount of bandwidth that can be reserved in this direction in this link. Units in bytes per second.
performanceMetric (optional)
PerformanceMetric Link performance information in real time.
teDefaultMetric (optional)
Long Traffic Engineering Metric.
teSrlgs (optional)
TeSrlgs A list of SLRGs.
unreservedBandwidth (optional)

TeLinkInfoAttributes Up

interfaceSwitchingCapabilityList (optional)
InterfaceSwitchingCapabilityList List of Interface Switching Capabilities Descriptors (ISCD)
teLinkConnectivityAttributes (optional)
TeLinkConnectivityAttributes Advertised TE connectivity attributes.
administrativeGroup (optional)
AdminGroups Administrative group or color of the link. This attribute covers both administrative group (defined in RFC3630, RFC5329, and RFC5305), and extended administrative group (defined in RFC7308).
linkIndex (optional)
Long The link identifier. If OSPF is used, this represents an ospfLsdbID. If IS-IS is used, this represents an isisLSPID. If a locally configured link is used, this object represents a unique value, which is locally defined in a router.
linkProtectionType (optional)
String Link Protection Type desired for this link.
Enum:
enhanced
extra_traffic
shared
_1_plus_1
unprotected
_1_for_1

TeLinkStateDerived Up

informationSource (optional)
String Indicates the source of the information.
Enum:
other
locally_configured
ospfv2
isis
ospfv3
system_processed
unknown
informationSourceState (optional)
InformationSourceState The container contains state attributes related to the information source.
informationSourceEntry (optional)
isTransitional (optional)
Object Present if the link is transitional, used as an alternative approach in lieu of inter-layer-lock-id for path computation in a TE topology covering multiple layers or multiple regions.
operStatus (optional)
String The current operational state of the link.
Enum:
testing
up
preparing_maintenance
down
maintenance
unknown
recovery (optional)
Recovery Status of the recovery process.
underlay (optional)
TeLinkStateDerivedUnderlay State attributes for te-link underlay.

TeLinkStateDerivedUnderlay Up

teLinkStateUnderlayAttributes (optional)
TeLinkStateUnderlayAttributes State attributes for te-link underlay.
teTopologyHierarchy (optional)

TeLinkStateUnderlayAttributes Up

TeLinkUnderlayAttributes Up

underlayBackupPath (optional)
underlayPrimaryPath (optional)
UnderlayPrimaryPath The service path on the underlay topology that supports this link.
underlayProtectionType (optional)
Integer Underlay protection type desired for this link
underlayTrailDes (optional)
UnderlayTrailDes Destination TE link of the underlay trail.
underlayTrailSrc (optional)
UnderlayTrailSrc Source TE link of the underlay trail.

TeNodeAttributes Up

adminStatus (optional)
String The administrative state of the link.
Enum:
testing
up
preparing_maintenance
down
maintenance
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
teNodeConnectivityMatrix (optional)
TeNodeConnectivityMatrix Connectivity matrix on a TE node.
teNodeInfoAttributes (optional)
TeNodeInfoAttributes Advertised TE information attributes.

TeNodeAugment Up

te (optional)
TeNodeAugmentTe Indicates TE support.

TeNodeAugmentTe Up

config (optional)
TeNodeAugmentTeConfig Configuration data.
state (optional)
TeNodeAugmentTeState Operational state data.
teNodeId (optional)
TeNodeId The identifier of a node in the TE topology. A node is specific to a topology to which it belongs.
tunnelTerminationPoint (optional)

TeNodeAugmentTeConfig Up

teNodeConfig (optional)
TeNodeConfig TE node configuration grouping.

TeNodeAugmentTeState Up

teNodeConfig (optional)
TeNodeConfig TE node configuration grouping.
teNodeStateDerived (optional)
TeNodeStateDerived Node state attributes in a TE topology.

TeNodeConfig Up

teNodeAttributes (optional)
TeNodeAttributes Containing node attributes in a TE topology.
teNodeTemplate (optional)
array[String] The reference to a TE node template.
template (optional)

TeNodeConfigAttributesTemplate Up

teNodeAttributes (optional)
TeNodeConfigAttributesTemplateTeNodeAttributes Containing node attributes in a TE topology.

TeNodeConfigAttributesTemplateTeNodeAttributes Up

adminStatus (optional)
String The administrative state of the link.
Enum:
testing
up
preparing_maintenance
down
maintenance
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
teNodeInfoAttributes (optional)
TeNodeInfoAttributes Advertised TE information attributes.

TeNodeConnectivityMatrix Up

connectivityMatrix (optional)

TeNodeId Up

dottedQuad (optional)

TeNodeInfoAttributes Up

domainId (optional)
Long Identifies the domain that this node belongs. This attribute is used to support inter-domain links.
isAbstract (optional)
Object Present if the node is abstract, not present if the node is actual.
name (optional)
DomainName Node name.
signalingAddress (optional)
array[IpAddress] Node signaling address.
underlayTopology (optional)
UnderlayTopology When an abstract node encapsulates a topology, the attributes in this container point to said topology.

TeNodeStateDerived Up

informationSource (optional)
String Indicates the source of the information.
Enum:
other
locally_configured
ospfv2
isis
ospfv3
system_processed
unknown
informationSourceState (optional)
InformationSourceState The container contains state attributes related to the information source.
informationSourceEntry (optional)
isMultiAccessDr (optional)
Object The presence of this attribute indicates that this TE node is a pseudonode elected as a designated router.
operStatus (optional)
String The current operational state of the node.
Enum:
testing
up
preparing_maintenance
down
maintenance
unknown

TeNodeStateDerivedInformationSourceEntry Up

informationSourceAttributes (optional)
teNodeConnectivityMatrix (optional)
teNodeInfoAttributes (optional)

TeNodeTunnelTerminationCapability Up

encoding (optional)
LspEncodingTypes Encoding supported by this interface.
interLayerLockId (optional)
Long Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions.
protectionType (optional)
LspProtType The protection type that this tunnel termination point is capable of.
switchingCapability (optional)
SwitchingCapabilities Switching Capability for this interface.
terminationCapability (optional)

TeOptimizationCriterion Up

TePathElement Up

asNumber (optional)
Integer AS number
v4Address (optional)
Ipv4Address An IPv4 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.
v4PrefixLength (optional)
Integer Length in bits of the IPv4 prefix
value (optional)
Long the label value
interfaceId (optional)
Long The interface identifier
routerId (optional)
IpAddress A router-id address
v6Address (optional)
Ipv6Address An IPv6 address. This address is treated as a prefix based on the prefix length value below. Bits beyond the prefix are ignored on receipt and SHOULD be set to zero on transmission.
v6PrefixLength (optional)
Integer Length in bits of the IPv4 prefix

TePerformanceMetric Up

TeSrlgs Up

value (optional)
array[Srlg] SRLG value.

TeTemplateName Up

string (optional)

TeTerminationPointAugment Up

te (optional)
TeTerminationPointAugmentTe Indicates TE support.

TeTerminationPointAugmentTe Up

config (optional)
state (optional)
TeTerminationPointAugmentTeState Operational state data.
teTpId (optional)
TeTpId An identifier to uniquely identify a TE termination point.

TeTerminationPointAugmentTeConfig Up

teTerminationPointConfig (optional)
TeTerminationPointConfig TE termination point configuration grouping.

TeTerminationPointAugmentTeState Up

teTerminationPointConfig (optional)
TeTerminationPointConfig TE termination point configuration grouping.

TeTerminationPointConfig Up

interfaceSwitchingCapabilityList (optional)
InterfaceSwitchingCapabilityList List of Interface Switching Capabilities Descriptors (ISCD)
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
interLayerLockId (optional)
Long Inter layer lock ID, used for path computation in a TE topology covering multiple layers or multiple regions.

TeTopologiesAugment Up

te (optional)
TeTopologiesAugmentTe Indicates TE support.

TeTopologiesAugmentTe Up

templates (optional)
Templates Configuration parameters for templates used for TE topology.

TeTopologyAugment Up

te (optional)
TeTopologyAugmentTe Indicates TE support.

TeTopologyAugmentTe Up

clientId (optional)
TeGlobalId An identifier to uniquely identify a client.
config (optional)
TeTopologyAugmentTeConfig Configuration data.
providerId (optional)
TeGlobalId An identifier to uniquely identify a provider.
state (optional)
TeTopologyAugmentTeState Operational state data.
teTopologyId (optional)
TeTopologyId It is presumed that a datastore will contain many topologies. To distinguish between topologies it is vital to have UNIQUE topology identifiers.

TeTopologyAugmentTeConfig Up

teTopologyConfig (optional)
TeTopologyConfig TE topology configuration grouping.

TeTopologyAugmentTeState Up

teTopologyConfig (optional)
TeTopologyConfig TE topology configuration grouping.

TeTopologyConfig Up

schedules (optional)
SchedulesMember Container of a schedule list defining when a particular configuration takes effect.
optimizationCriterion (optional)
TeOptimizationCriterion Optimization criterion applied to this topology.
preference (optional)
Integer Specifies a preference for this topology. A lower number indicates a higher preference.

TeTopologyHierarchy Up

TeTopologyId Up

string (optional)

TeTopologyRef Up

clientIdRef (optional)
String A reference to a client-id.
networkIdRef (optional)
String A reference to a network-id in base ietf-network module.
providerIdRef (optional)
String A reference to a provider-id.
teTopologyIdRef (optional)
String A reference to a te-topology-id.

TeTpId Up

ipAddress (optional)
uint32 (optional)

Template Up

TemplateAttributes Up

priority (optional)
Integer The preference value to resolve conflicts between different templates. When two or more templates specify values for one configuration attribute, the value from the template with the highest priority is used.
referenceChangePolicy (optional)
String This attribute specifies the action taken to a configuration node that has a reference to this template.
Enum:
no_action
cascade
not_allowed

Templates Up

linkTemplate (optional)
nodeTemplate (optional)

Tenant Up

address (optional)
String The mailing address for the tenant
contactName (optional)
String The contact name for the tenant
id (optional)
String The unique identifier for the tenant
phoneNumber (optional)
String The phone number for the tenant
tenantName (optional)
String The name of the tenant

TerminationCapability Up

labelRestriction (optional)
maxLspBandwidth (optional)
linkTp (optional)
String Link termination point.

TerminationPoint Up

supportingTerminationPoint (optional)
tpId (optional)
TpId Termination point identifier.

ThresholdAcceleratedAdvertisement Up

performanceMetricAttributes (optional)
PerformanceMetricAttributes Link performance information in real time.

ThresholdIn Up

performanceMetricAttributes (optional)
PerformanceMetricAttributes Link performance information in real time.

ThresholdOut Up

performanceMetricAttributes (optional)
PerformanceMetricAttributes Link performance information in real time.

Tier1Scheduler Up

scheduler (optional)
Scheduler The parameters of a scheduler

TimeDivisionMultiplexCapable Up

indication (optional)
String Indication whether the interface supports Standard or Arbitrary SONET/SDH
Enum:
standard
arbitrary
minimumLspBandwidth (optional)
Double Minimum LSP Bandwidth. Units in bytes per second.

To Up

tpRef (optional)
String Relative reference to destination termination point.

Topology Up

serviceTopology (optional)
ServiceTopology The topology for the service

TpId Up

uri (optional)

TpRef Up

networkRef (optional)
String Used to reference a network, for example an underlay network.
nodeRef (optional)
String Used to reference a node. Nodes are identified relative to the network they are contained in.
tpRef (optional)
String A type for an absolute reference to a termination point. (This type should not be used for relative references. In such a case, a relative path should be used instead.)

TunnelCreationTemplate Up

appId (optional)
String The client-defined custom Application ID for this object
id (optional)
String The unique identifier of the template
name (optional)
String The name of the template
objectDescription (optional)
String The description for this object
consumable (optional)
Boolean Specifies whether or not the tunnel is consumable
deletable (optional)
Boolean Specifies whether or not the tunnel is deletable
modifiable (optional)
Boolean Specifies whether or not the tunnel is modifiable
protection (optional)
Boolean Specifies whether or not the tunnel has a protection path. Protection path is only signalled after the primary path fails.
protectionType (optional)
String Specifies path protection type. Protection path is pre-signalled and available for immediate recovery after a primary path failure.
Enum:
SECONDARY
STANDBY

TunnelSelectionTemplate Up

strictRsvpPriority (optional)
Integer Specifies the priority for selecting strict RSVP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude strict RSVP tunnels from selection, [-1..7]
pccInitiatedLspEnabled (optional)
Boolean Specifies whether or not the policy can use PCC initiated tunnel
bgpPriority (optional)
Integer Specifies the priority for selecting BGP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude BGP tunnels from selection, [-1..7]
ldpPriority (optional)
Integer Specifies the priority for selecting LDP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude LDP tunnels from selection, [-1..7]
grePriority (optional)
Integer Specifies the priority for selecting GRE tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude GRE tunnels from selection, [-1..7]
canRebindTunnel (optional)
Boolean Specifies whether or not the policy can rebind tunnel
steeringParametersExcluded (optional)
canCreateNewTunnel (optional)
Boolean Specifies whether or not the policy can create new tunnel
steeringParametersIncluded (optional)
looseRsvpPriority (optional)
Integer Specifies the priority for selecting loose RSVP tunnels. A lower value indicates a higher priority. A value of -1 indicates to exclude loose RSVP tunnels from selection, [-1..7]
shouldAvoidOperStateDown (optional)
Boolean Specifies whether or not the policy should avoid resource which their operational state is down
appId (optional)
String The client-defined custom Application ID for this object
name (optional)
String The name of the template
canResizeExistingTunnel (optional)
Boolean Specifies whether or not the policy can resize an existing tunnel
id (optional)
String The unique identifier of the template
objectDescription (optional)
String The description for this object
canUseExistingTunnel (optional)
Boolean Specifies whether or not the policy can use an existing tunnel

TunnelTerminationPoint Up

teNodeTunnelTerminationCapability (optional)
TeNodeTunnelTerminationCapability Termination capability of a tunnel termination point on a TE node.
tunnelTpId (optional)
array[byte[]] Tunnel termination point identifier.

Underlay Up

teLinkUnderlayAttributes (optional)
TeLinkUnderlayAttributes Attributes for te-link underlay.
teTopologyHierarchy (optional)
teLinkStateUnderlayAttributes (optional)
TeLinkStateUnderlayAttributes State attributes for te-link underlay.

UnderlayBackupPath Up

clientIdRef (optional)
String A reference to a client-id.
networkIdRef (optional)
String A reference to a network-id in base ietf-network module.
providerIdRef (optional)
String A reference to a provider-id.
teTopologyIdRef (optional)
String A reference to a te-topology-id.
pathElement (optional)
index (optional)
Long A sequence number to identify a backup path.

UnderlayPrimaryPath Up

pathElement (optional)
teTopologyRef (optional)
TeTopologyRef References a TE topology.

UnderlayTopology Up

teTopologyHierarchy (optional)
teTopologyRef (optional)
TeTopologyRef References a TE topology.

UnderlayTrailDes Up

tpRef (optional)
TpRef References a termination point in a specific node.

UnderlayTrailSrc Up

tpRef (optional)
TpRef References a termination point in a specific node.

Uri Up

string (optional)

UrlSafeString Up

string (optional)

User Up

id (optional)
String The user unique identifier
name (optional)
String The user name

UserInfo Up

password (optional)
String The password for the user
userName (optional)
String The user name

VipAllSubnetSteeringEntryRequest Up

nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to

VipCustomerAndSubnetBwEntry Up

bandwidth (optional)
Long Bandwidth in kbps
customerId (optional)
String The unique identifier for the VIP customer
subnetsBandwidth (optional)

VipCustomerBwEntry Up

bandwidth (optional)
Long Bandwidth in kbps
customerId (optional)
String The unique identifier for the VIP customer

VipCustomerEntry Up

appGroupId (optional)
Long Application group ID used by steered flows for this customer
applicationId (optional)
Integer The VIP steering Application ID
id (optional)
String The unique identifier for the VIP customer
name (optional)
String Customer name
subnetCount (optional)
Long Number of subnets on this customer

VipCustomerEntryRequest Up

name (optional)
String Customer name

VipSteeringEntry Up

customerId (optional)
String The unique identifier for the VIP customer
state (optional)
String Steering state
Enum:
ACTIVE
PENDING
steeredSubnetCount (optional)
Long The number of subnets steered
subnetsSteeringEntry (optional)

VipSubnetBwEntry Up

bandwidth (optional)
Long Bandwidth in kbps
subnetId (optional)
String The unique identifier for the VIP subnet

VipSubnetEntry Up

id (optional)
String The unique identifier for the VIP subnet
subnetPrefix (optional)
IpPrefix Subnet prefix

VipSubnetEntryRequest Up

subnetPrefix (optional)
IpPrefix Subnet prefix

VipSubnetSteeringEntry Up

flowId (optional)
String The unique identifier of the flow used for steering
nextHopBundleIds (optional)
array[String] The unique identifier of the next hop bundle(s) this subnet is steered to
nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to
subnetPrefix (optional)
IpPrefix Subnet prefix
vipSubnetId (optional)
String The unique identifier for the VIP subnet

VipSubnetSteeringEntryRequest Up

nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to
vipSubnetId (optional)
String The unique identifier for the VIP subnet