NSD-NRCs REST API - v3
This API describes the REST interface to interact with the NSD-NRCs
BasePath:/sdn
Access
[ Jump to Models ]
Table of Contents
post /api/v3/generic/find-by-external-id
get /api/v3/generic/{uuid}
get /api/v3/generic/application-id/{id}
get /api/v3/generic/consumed/{uuid}
get /api/v3/generic/tenants/{uuid}
put /api/v3/generic/application-id/{id}/{appId}
get /api/v3/ietf/te/link/{linkId}
get /api/v3/ietf/te/network/{networkId}
get /api/v3/ietf/te/networks
get /api/v3/ietf/te/node/{nodeId}
get /api/v3/ietf/te/termination-point/{tpId}
get /api/v3/ne/{uuid}
get /api/v3/ne/system/{systemId}
get /api/v3/ne
put /api/v3/ne/{id}
post /api/v3/openflow/flows
delete /api/v3/openflow/flows
post /api/v3/openflow/flows/search
post /api/v3/openflow/flows/search-by-id
get /api/v3/openflow/ports/{datapathId}
get /api/v3/openflow/switches
get /api/v3/openflow/switches/{neId}
get /api/v3/openflow/tables/{datapathId}
post /api/v3/physicallinks/{srcId}/{destId}
delete /api/v3/physicallinks/{linkId}
get /api/v3/physicallinks/{uuid}
get /api/v3/physicallinks
post /api/v3/policy/steering-parameter
post /api/v3/policy/tunnel-selections
delete /api/v3/policy/steering-parameter/{steeringParameterName}
delete /api/v3/policy/tunnel-selections/{policyId}
get /api/v3/policy/rd-rt-ranges
get /api/v3/policy/tunnel-selections
get /api/v3/policy/steering-parameters
get /api/v3/policy/tunnel-selections/{policyId}
put /api/v3/policy/rd-rt-ranges/{policyId}
put /api/v3/policy/tunnel-selections/{policyId}
get /api/v3/ports/{portUuid}
get /api/v3/ports/ne/{neUuid}/servicetype/{serviceType}
get /api/v3/ports/ne-all/{neId}
get /api/v3/ports/service-count-on-port/{portUuid}
get /api/v3/ports/servicetype/{serviceType}
get /api/v3/ports/tenant/{tenantUuid}
put /api/v3/ports/{id}
post /api/v3/security/token
get /api/v3/security/authentication
get /api/v3/security/token/{userName}/{password}
post /api/v3/services/elans/{serviceUuid}/endpoint
post /api/v3/services/l3-vpns/{serviceUuid}/endpoint
post /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint
post /api/v3/services/clines
post /api/v3/services/elans
post /api/v3/services/elines
post /api/v3/services/l3-vpns
post /api/v3/services/lags
post /api/v3/services/optical
delete /api/v3/services/{uuid}
delete /api/v3/services/{serviceUuid}/endpoint/{endpointUuid}
get /api/v3/services/{uuid}
get /api/v3/services/{serviceUuid}/endpoints
get /api/v3/services/resource-count/{tenantUuid}/{resourceType}
get /api/v3/services/tenant/{uuid}
get /api/v3/services/tunnel/{tunnelUuid}
get /api/v3/services/tunnels
get /api/v3/services
patch /api/v3/services/clines/{serviceUuid}/endpoint/{endpointUuid}
patch /api/v3/services/clines/{serviceUuid}
patch /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid}
patch /api/v3/services/elans/{serviceUuid}
patch /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid}
patch /api/v3/services/elines/{serviceUuid}
patch /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}
patch /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}
patch /api/v3/services/l3-vpns/{serviceUuid}
put /api/v3/services/clines/{serviceUuid}/endpoint/{endpointUuid}
put /api/v3/services/clines/{serviceUuid}
put /api/v3/services/elans/{serviceUuid}/endpoint/{endpointUuid}
put /api/v3/services/elans/{serviceUuid}
put /api/v3/services/elines/{serviceUuid}/endpoint/{endpointUuid}
put /api/v3/services/elines/{serviceUuid}
put /api/v3/services/l3-vpns/{serviceUuid}/endpoint/{endpointUuid}
put /api/v3/services/l3-vpns/{serviceUuid}/loopback-endpoint/{endpointUuid}
put /api/v3/services/l3-vpns/{serviceUuid}
put /api/v3/services/optical/{serviceUuid}
put /api/v3/services/tunnel/{tunnelUuid}
post /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}/all
post /api/v3/steering/as/{asNumber}
post /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
post /api/v3/steering/monitored-router/{id}/ports
post /api/v3/steering/monitored-router
post /api/v3/steering/next-hop-bundle
post /api/v3/steering/vip/customer
post /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
post /api/v3/steering/vip/customer/{id}/subnets
delete /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}/all
delete /api/v3/steering/vip/customer/{id}/subnets/all
delete /api/v3/steering/as/{asNumber}
delete /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
delete /api/v3/steering/monitored-router/{id}/ports
delete /api/v3/steering/monitored-router/{id}
delete /api/v3/steering/next-hop-bundle/{id}
delete /api/v3/steering/vip/customer/{id}
delete /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
delete /api/v3/steering/vip/customer/{id}/subnets
get /api/v3/steering/as/bw/{monitoredRouterId}
get /api/v3/steering/as/bw/{monitoredRouterId}/{asNumber}
get /api/v3/steering/as
get /api/v3/steering/as/{asNumber}
get /api/v3/steering/as/steer/{monitoredRouterId}
get /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}
get /api/v3/steering/as/steer/{monitoredRouterId}/{asNumber}/details
post /api/v3/steering/as/steer/search
get /api/v3/steering/as/{asNumber}/subnets
get /api/v3/steering/monitored-router/port/{monitoredPortId}
get /api/v3/steering/monitored-router/{id}/ports
get /api/v3/steering/monitored-router/{id}
get /api/v3/steering/monitored-router
get /api/v3/steering/next-hop-bundle/{id}
post /api/v3/steering/next-hop-bundle/search
get /api/v3/steering/next-hop-bundle
get /api/v3/steering/monitored-router/port/{monitoredPortId}/historical-utilization/{timeStamp}
get /api/v3/steering/vip/customer/{id}
get /api/v3/steering/vip/bw/{monitoredRouterId}
post /api/v3/steering/vip/customer/search
get /api/v3/steering/vip/customer
get /api/v3/steering/vip/steer/{monitoredRouterId}
get /api/v3/steering/vip/steer/{monitoredRouterId}/{customerId}
post /api/v3/steering/vip/steer/search
get /api/v3/steering/vip/bw/{monitoredRouterId}/{customerId}
get /api/v3/steering/vip/customer/{id}/subnets
put /api/v3/steering/as/{asNumber}
put /api/v3/steering/as/{asNumber}/refresh
put /api/v3/steering/monitored-router/port/{monitoredPortId}/heartbeat
put /api/v3/steering/monitored-router/{id}/ports
put /api/v3/steering/monitored-router/{id}
put /api/v3/steering/next-hop-bundle/{id}
put /api/v3/steering/vip/customer/{id}
put /api/v3/steering/vip/customer/{id}/subnets
get /api/v3/system/state
get /api/v3/system/version
get /api/v3/system/isMaster
get /api/v3/system/resync-nms
post /api/v3/template/cline-services
post /api/v3/template/custom-attributes
post /api/v3/template/elan-services
post /api/v3/template/eline-services
post /api/v3/template/l3-vpn-services
post /api/v3/template/lag-services
post /api/v3/template/och-services
post /api/v3/template/odu-services
post /api/v3/template/path-profiles
post /api/v3/template/qos
post /api/v3/template/router-id-system-id-mapping
delete /api/v3/template/cline-services/{templateId}
delete /api/v3/template/custom-attributes/{templateId}
delete /api/v3/template/elan-services/{templateId}
delete /api/v3/template/eline-services/{templateId}
delete /api/v3/template/l3-vpn-services/{templateId}
delete /api/v3/template/lag-services/{templateId}
delete /api/v3/template/och-services/{templateId}
delete /api/v3/template/odu-services/{templateId}
delete /api/v3/template/path-profiles/{templateId}
delete /api/v3/template/qos/{templateId}
delete /api/v3/template/router-id-system-id-mapping/{policyId}
get /api/v3/template/cline-services
get /api/v3/template/custom-attributes
get /api/v3/template/elan-services
get /api/v3/template/eline-services
get /api/v3/template/generic-qos
get /api/v3/template/l3-vpn-services
get /api/v3/template/lag-services
get /api/v3/template/och-services
get /api/v3/template/odu-services
get /api/v3/template/path-profiles
get /api/v3/template/qos
get /api/v3/template/router-id-system-id-mapping
get /api/v3/template/tunnel-creations
get /api/v3/template/cline-services/{templateId}
get /api/v3/template/custom-attributes/{templateId}
get /api/v3/template/elan-services/{templateId}
get /api/v3/template/eline-services/{templateId}
get /api/v3/template/generic-qos/{id}
get /api/v3/template/l3-vpn-services/{templateId}
get /api/v3/template/lag-services/{templateId}
get /api/v3/template/och-services/{templateId}
get /api/v3/template/odu-services/{templateId}
get /api/v3/template/path-profiles/{templateId}
get /api/v3/template/qos/{templateId}
get /api/v3/template/router-id-system-id-mapping/{policyId}
put /api/v3/template/cline-services/{templateId}
put /api/v3/template/custom-attributes/{templateId}
put /api/v3/template/elan-services/{templateId}
put /api/v3/template/eline-services/{templateId}
put /api/v3/template/l3-vpn-services/{templateId}
put /api/v3/template/lag-services/{templateId}
put /api/v3/template/och-services/{templateId}
put /api/v3/template/odu-services/{templateId}
put /api/v3/template/path-profiles/{templateId}
put /api/v3/template/qos/{templateId}
put /api/v3/template/router-id-system-id-mapping/{policyId}
put /api/v3/template/tunnel-creations/{templateId}
post /api/v3/tenants/{tenantUuid}/resources
post /api/v3/tenants
post /api/v3/tenants/{tenantUuid}/user/{userUuid}/role/{roleType}
delete /api/v3/tenants/{tenantUuid}
delete /api/v3/tenants/{tenantUuid}/resources
delete /api/v3/tenants/{tenantUuid}/user/{userUuid}
get /api/v3/tenants/{tenantUuid}
get /api/v3/tenants/{tenantUuid}/resources
get /api/v3/tenants/{tenantUuid}/user/{userUuid}
get /api/v3/tenants
get /api/v3/tenants/resync/{provider}
post /api/v3/users
delete /api/v3/users/{userUuid}
get /api/v3/users/{userUuid}
get /api/v3/users/{userUuid}/tenants
get /api/v3/users
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Query all Tenants (gets)
Query all Tenants
Consumes
This API call consumes the following media types via the
Content-Type request header:
Return type
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
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
Produces
This API call produces the following media types according to the 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
Produces
This API call produces the following media types according to the 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
[ Jump to Methods ]
Table of Contents
AdminGroup
AdminGroups
AsBw
AsEntry
AsEntryRequest
AsNumber
AsSteeringEntry
AsSteeringEntryDetail
AsSteeringEntryRequest
AsSubnetEntry
Authentication
BaseEntity
BaseService
BaseServiceEndpoint
BundledLink
BundledLinks
ClineServiceCreationTemplate
ClineServiceRequest
ComponentLink
ComponentLinks
Config
ConnectivityLabelRestrictionList
ConnectivityMatrix
CosMapping
CustomAttribute
CustomAttributesTemplate
DateAndTime
Destination
DomainName
DottedQuad
EbgpRoute
EgressParam
ElanServiceCreationTemplate
ElineRequestData
ElineServiceCreationTemplate
EndpointList
Entry«int,double»
Entry«long,BundledLink»
Entry«long,ComponentLink»
Entry«long,ConnectivityMatrix»
Entry«long,Schedule»
Entry«long,TePathElement»
Entry«long,UnderlayBackupPath»
Entry«string,InformationSourceEntry»
Entry«string,InterfaceSwitchingCapability»
Entry«string,LabelRestriction»
Entry«string,LinkTemplate»
Entry«string,Link»
Entry«string,Network»
Entry«string,NodeTemplate»
Entry«string,Node»
Entry«string,SupportingLink»
Entry«string,SupportingNode»
Entry«string,SupportingTerminationPoint»
Entry«string,TeNodeStateDerivedInformationSourceEntry»
Entry«string,TerminationCapability»
Entry«string,TerminationPoint»
Entry«string,TunnelTerminationPoint»
ErrorMessages
ErrorReport
ErrorReports
ErrorResponseData
Ethernet
ExtendedAdminGroup
ExternalDomain
ExternalId
From
GeneralizedLabel
GeoLocation
GroupConnection
InformationSourceAttributes
InformationSourceEntry
InformationSourceState
IngressParam
InterfaceSwitchingCapability
InterfaceSwitchingCapabilityList
IpAddress
IpElanServiceRequest
IpL3ServiceRequest
IpPrefix
Ipv4Address
Ipv4Prefix
Ipv6Address
Ipv6Prefix
L2EndpointRequest
L3EndpointRequest
L3vpnRdRtPolicy
L3vpnServiceCreationTemplate
LabelRestriction
Lag
LagMemberInfo
LagRequest
LagServiceCreationTemplate
LifeCycle
Link
LinkCost
LinkId
LinkTemplate
LldpConfigurationInfo
LldpRemotePeerInfo
LoopbackEndpointRequest
LspEncodingTypes
LspProtType
Measurement
MonitoredPort
MonitoredPortRequest
MonitoredRouter
MonitoredRouterModifyRequest
MonitoredRouterRequest
Network
NetworkElement
NetworkElementRequest
NetworkId
NetworkIdentifierType
NetworkTypes
Networks
NextHopBundle
NextHopBundleModifyRequest
NextHopBundleRequest
NextHopBundleSearch
Node
NodeId
NodeTemplate
Normality
NspOpticsExplicitRoute
NspToken
OchServiceCreationTemplate
OduServiceCreationTemplate
OpenflowAction
OpenflowFlowEntry
OpenflowFlowEntryRequest
OpenflowFlowSearch
OpenflowFlowSearchById
OpenflowInstruction
OpenflowMatch
OpenflowPort
OpenflowSwitch
OpenflowTable
Optics
OpticsRequest
Ownership
PathProfileTemplate
PerformanceMetric
PerformanceMetricAttributes
PerformanceMetricNormalityAttributes
PerformanceMetricThrottle
PerformanceMetricThrottleContainer
PhysicalLink
Platform
Port
PortRequest
PortUtilizationHistory
QosProfile
QosTemplate
Queue
Recovery
Request«AsEntryRequest»
Request«AsSteeringEntryRequest»
Request«ClineServiceCreationTemplate»
Request«ClineServiceRequest»
Request«CustomAttributesTemplate»
Request«ElanServiceCreationTemplate»
Request«ElineRequestData»
Request«ElineServiceCreationTemplate»
Request«ExternalId»
Request«IpElanServiceRequest»
Request«IpL3ServiceRequest»
Request«L2EndpointRequest»
Request«L3EndpointRequest»
Request«L3vpnRdRtPolicy»
Request«L3vpnServiceCreationTemplate»
Request«LagRequest»
Request«LagServiceCreationTemplate»
Request«List«MonitoredPortRequest»»
Request«List«OpenflowFlowEntryRequest»»
Request«List«VipSubnetEntryRequest»»
Request«List«VipSubnetSteeringEntryRequest»»
Request«List«string»»
Request«LoopbackEndpointRequest»
Request«MonitoredRouterModifyRequest»
Request«MonitoredRouterRequest»
Request«NetworkElementRequest»
Request«NextHopBundleModifyRequest»
Request«NextHopBundleRequest»
Request«NextHopBundleSearch»
Request«OchServiceCreationTemplate»
Request«OduServiceCreationTemplate»
Request«OpenflowFlowSearchById»
Request«OpenflowFlowSearch»
Request«OpticsRequest»
Request«PathProfileTemplate»
Request«PortRequest»
Request«QosTemplate»
Request«RouterIdSystemIdMapping»
Request«ServiceTunnelRequest»
Request«SteeringEntrySearch»
Request«SteeringParameter»
Request«TdmEndpointRequest»
Request«Tenant»
Request«TunnelCreationTemplate»
Request«TunnelSelectionTemplate»
Request«UserInfo»
Request«VipAllSubnetSteeringEntryRequest»
Request«VipCustomerEntryRequest»
Request«VipSubnetEntryRequest»
ResponseData«AsBw»
ResponseData«AsEntry»
ResponseData«AsSteeringEntry»
ResponseData«Authentication»
ResponseData«BaseEntity»
ResponseData«BaseService»
ResponseData«ClineServiceCreationTemplate»
ResponseData«CustomAttributesTemplate»
ResponseData«ElanServiceCreationTemplate»
ResponseData«ElineServiceCreationTemplate»
ResponseData«L3vpnServiceCreationTemplate»
ResponseData«LagServiceCreationTemplate»
ResponseData«Link»
ResponseData«List«AsBw»»
ResponseData«List«AsEntry»»
ResponseData«List«AsSteeringEntryDetail»»
ResponseData«List«AsSteeringEntry»»
ResponseData«List«AsSubnetEntry»»
ResponseData«List«BaseEntity»»
ResponseData«List«BaseServiceEndpoint»»
ResponseData«List«BaseService»»
ResponseData«List«ClineServiceCreationTemplate»»
ResponseData«List«CustomAttributesTemplate»»
ResponseData«List«ElanServiceCreationTemplate»»
ResponseData«List«ElineServiceCreationTemplate»»
ResponseData«List«L3vpnRdRtPolicy»»
ResponseData«List«L3vpnServiceCreationTemplate»»
ResponseData«List«LagServiceCreationTemplate»»
ResponseData«List«MonitoredPort»»
ResponseData«List«MonitoredRouter»»
ResponseData«List«NetworkElement»»
ResponseData«List«NextHopBundle»»
ResponseData«List«OchServiceCreationTemplate»»
ResponseData«List«OduServiceCreationTemplate»»
ResponseData«List«OpenflowFlowEntry»»
ResponseData«List«OpenflowPort»»
ResponseData«List«OpenflowSwitch»»
ResponseData«List«OpenflowTable»»
ResponseData«List«PathProfileTemplate»»
ResponseData«List«PhysicalLink»»
ResponseData«List«PortUtilizationHistory»»
ResponseData«List«Port»»
ResponseData«List«QosProfile»»
ResponseData«List«QosTemplate»»
ResponseData«List«RouterIdSystemIdMapping»»
ResponseData«List«ServiceTunnel»»
ResponseData«List«SteeringParameter»»
ResponseData«List«Tenant»»
ResponseData«List«TunnelCreationTemplate»»
ResponseData«List«TunnelSelectionTemplate»»
ResponseData«List«User»»
ResponseData«List«VipCustomerBwEntry»»
ResponseData«List«VipCustomerEntry»»
ResponseData«List«VipSteeringEntry»»
ResponseData«List«VipSubnetEntry»»
ResponseData«List«string»»
ResponseData«MonitoredPort»
ResponseData«MonitoredRouter»
ResponseData«NetworkElement»
ResponseData«Networks»
ResponseData«Network»
ResponseData«NextHopBundle»
ResponseData«Node»
ResponseData«NspToken»
ResponseData«OchServiceCreationTemplate»
ResponseData«OduServiceCreationTemplate»
ResponseData«PathProfileTemplate»
ResponseData«PhysicalLink»
ResponseData«Port»
ResponseData«QosProfile»
ResponseData«QosTemplate»
ResponseData«RouterIdSystemIdMapping»
ResponseData«ServiceTunnel»
ResponseData«SteeringParameter»
ResponseData«Tenant»
ResponseData«TerminationPoint»
ResponseData«TunnelSelectionTemplate»
ResponseData«User»
ResponseData«VipCustomerAndSubnetBwEntry»
ResponseData«VipCustomerEntry»
ResponseData«VipSteeringEntry»
ResponseData«boolean»
ResponseData«long»
ResponseData«string»
Response«AsBw»
Response«AsEntry»
Response«AsSteeringEntry»
Response«Authentication»
Response«BaseEntity»
Response«BaseService»
Response«ClineServiceCreationTemplate»
Response«CustomAttributesTemplate»
Response«ElanServiceCreationTemplate»
Response«ElineServiceCreationTemplate»
Response«ErrorMessages»
Response«L3vpnServiceCreationTemplate»
Response«LagServiceCreationTemplate»
Response«Link»
Response«List«AsBw»»
Response«List«AsEntry»»
Response«List«AsSteeringEntryDetail»»
Response«List«AsSteeringEntry»»
Response«List«AsSubnetEntry»»
Response«List«BaseEntity»»
Response«List«BaseServiceEndpoint»»
Response«List«BaseService»»
Response«List«ClineServiceCreationTemplate»»
Response«List«CustomAttributesTemplate»»
Response«List«ElanServiceCreationTemplate»»
Response«List«ElineServiceCreationTemplate»»
Response«List«L3vpnRdRtPolicy»»
Response«List«L3vpnServiceCreationTemplate»»
Response«List«LagServiceCreationTemplate»»
Response«List«MonitoredPort»»
Response«List«MonitoredRouter»»
Response«List«NetworkElement»»
Response«List«NextHopBundle»»
Response«List«OchServiceCreationTemplate»»
Response«List«OduServiceCreationTemplate»»
Response«List«OpenflowFlowEntry»»
Response«List«OpenflowPort»»
Response«List«OpenflowSwitch»»
Response«List«OpenflowTable»»
Response«List«PathProfileTemplate»»
Response«List«PhysicalLink»»
Response«List«PortUtilizationHistory»»
Response«List«Port»»
Response«List«QosProfile»»
Response«List«QosTemplate»»
Response«List«RouterIdSystemIdMapping»»
Response«List«ServiceTunnel»»
Response«List«SteeringParameter»»
Response«List«Tenant»»
Response«List«TunnelCreationTemplate»»
Response«List«TunnelSelectionTemplate»»
Response«List«User»»
Response«List«VipCustomerBwEntry»»
Response«List«VipCustomerEntry»»
Response«List«VipSteeringEntry»»
Response«List«VipSubnetEntry»»
Response«List«string»»
Response«MonitoredPort»
Response«MonitoredRouter»
Response«NetworkElement»
Response«Networks»
Response«Network»
Response«NextHopBundle»
Response«Node»
Response«NspToken»
Response«OchServiceCreationTemplate»
Response«OduServiceCreationTemplate»
Response«PathProfileTemplate»
Response«PhysicalLink»
Response«Port»
Response«QosProfile»
Response«QosTemplate»
Response«RouterIdSystemIdMapping»
Response«ServiceTunnel»
Response«SteeringParameter»
Response«Tenant»
Response«TerminationPoint»
Response«TunnelSelectionTemplate»
Response«User»
Response«VipCustomerAndSubnetBwEntry»
Response«VipCustomerEntry»
Response«VipSteeringEntry»
Response«boolean»
Response«long»
Response«string»
RouteTarget
RouterIdSystemIdMapping
RouterInfo
RoutingBgp
RoutingStatic
Schedule
Scheduler
Schedules
SchedulesMember
ServiceEdge
ServiceTopology
ServiceTunnel
ServiceTunnelRequest
SiteServiceQosProfile
Source
Srlg
State
StaticRoute
SteeringEntrySearch
SteeringParameter
SupportingLink
SupportingNode
SupportingTerminationPoint
SwitchingCapabilities
Tdm
TdmDs0ChannelGroupInfo
TdmEndpointRequest
Te
TeGlobalId
TeLinkAttributes
TeLinkAugment
TeLinkConfig
TeLinkConfigAttributes
TeLinkConnectivityAttributes
TeLinkInfoAttributes
TeLinkStateDerived
TeLinkStateDerivedUnderlay
TeLinkStateUnderlayAttributes
TeLinkUnderlayAttributes
TeNodeAttributes
TeNodeAugment
TeNodeAugmentTe
TeNodeAugmentTeConfig
TeNodeAugmentTeState
TeNodeConfig
TeNodeConfigAttributesTemplate
TeNodeConfigAttributesTemplateTeNodeAttributes
TeNodeConnectivityMatrix
TeNodeId
TeNodeInfoAttributes
TeNodeStateDerived
TeNodeStateDerivedInformationSourceEntry
TeNodeTunnelTerminationCapability
TeOptimizationCriterion
TePathElement
TePerformanceMetric
TeSrlgs
TeTemplateName
TeTerminationPointAugment
TeTerminationPointAugmentTe
TeTerminationPointAugmentTeConfig
TeTerminationPointAugmentTeState
TeTerminationPointConfig
TeTopologiesAugment
TeTopologiesAugmentTe
TeTopologyAugment
TeTopologyAugmentTe
TeTopologyAugmentTeConfig
TeTopologyAugmentTeState
TeTopologyConfig
TeTopologyHierarchy
TeTopologyId
TeTopologyRef
TeTpId
Template
TemplateAttributes
Templates
Tenant
TerminationCapability
TerminationPoint
ThresholdAcceleratedAdvertisement
ThresholdIn
ThresholdOut
Tier1Scheduler
TimeDivisionMultiplexCapable
To
Topology
TpId
TpRef
TunnelCreationTemplate
TunnelSelectionTemplate
TunnelTerminationPoint
Underlay
UnderlayBackupPath
UnderlayPrimaryPath
UnderlayTopology
UnderlayTrailDes
UnderlayTrailSrc
Uri
UrlSafeString
User
UserInfo
VipAllSubnetSteeringEntryRequest
VipCustomerAndSubnetBwEntry
VipCustomerBwEntry
VipCustomerEntry
VipCustomerEntryRequest
VipSteeringEntry
VipSubnetBwEntry
VipSubnetEntry
VipSubnetEntryRequest
VipSubnetSteeringEntry
VipSubnetSteeringEntryRequest
adminGroup (optional)
extendedAdminGroup (optional)
asNumber (optional)
Long The number of the Autonomous System we are interested in steering
bandwidth (optional)
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
name (optional)
String The name of the Autonomous System
asNumber (optional)
Long The number of the Autonomous System we are steering
deploymentStatus (optional)
String Indicates the status of deploying subnets related flows
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
flowId (optional)
String The unique identifier of the flow used for steering
subnetPrefix (optional)
nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to
expires (optional)
Long Specifies the expiry date of the token in milliseconds since January 1, 1970, 00:00:00 GMT
roles (optional)
tenant (optional)
Tenant The Tenant in which the current user is currently authenticated against
user (optional)
User The User currently authenticated
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
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
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
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
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
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
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
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
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.
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
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
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service.
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)
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
adminState (optional)
String The current administrative state of the entity
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
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
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
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)
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)
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.
labelRestriction (optional)
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.
cos (optional)
String Class of Service for the qos profile
queueId (optional)
Integer The ID of an endpoint queue.
attributeName (optional)
attributeValue (optional)
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)
destNode (optional)
String Destination node identifier, must be in the same network.
destTp (optional)
String Termination point within destination node that terminates the link.
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
tier1Scheduler (optional)
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
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
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service.
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)
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
adminState (optional)
String The current administrative state of the entity
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
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
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
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)
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
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
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
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service.
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)
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
endpointConnectionConfig (optional)
String Specifies how the service endpoints in each of the groups are connected
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
errorReports (optional)
errors (optional)
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
protocol
application
rpc_notification
transport
encapType (optional)
String The encapsulation type of the ethernet port
Null
Unknown
Dot1Q
QinQ
lag (optional)
Lag Contains LAG related configuration
lldpConfiguration (optional)
lldpRemotePeers (optional)
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.
context (optional)
String The entity type that is managing this external-id
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.
tpRef (optional)
String Relative reference to source termination point.
latitude (optional)
Double The latitude of the geographical location in degrees
longitude (optional)
Double The longitude of the geographical location in degrees
groupA (optional)
String Specifies a group upon which to terminate the connectivity
groupB (optional)
String Specifies a group upon which to terminate the connectivity
informationSource (optional)
String Indicates the source of the information.
other
locally_configured
ospfv2
isis
ospfv3
system_processed
unknown
informationSourceState (optional)
informationSourceAttributes (optional)
teLinkInfoAttributes (optional)
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.
tier1Scheduler (optional)
timeDivisionMultiplexCapable (optional)
maxLspBandwidth (optional)
encoding (optional)
switchingCapability (optional)
interfaceSwitchingCapability (optional)
ipv4Address (optional)
ipv6Address (optional)
adminState (optional)
String The current administrative state of the entity
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
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
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
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)
SATOP_E1
SATOP_T1
CESOPSN
ETHERNET
CESOPSN_CAS
ETHERNET_TAGGED_MODE
topology (optional)
Topology The logical topology of a multipoint service
endpoints (optional)
adminState (optional)
String The current administrative state of the entity
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
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
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
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)
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
rsvp_te
ldp
gre
none
encryption (optional)
Boolean Specifies whether or not Network Group Encryption is enabled for the service
endpoints (optional)
loopbackEndpoints (optional)
ipv6Prefix (optional)
ipv4Prefix (optional)
adminState (optional)
String The current administrative state of the entity
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)
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)
adminState (optional)
String The current administrative state of the entity
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)
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)
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)
routingStatic (optional)
secondaryAddresses (optional)
array[IpPrefix] A list of secondary IP addresses assigned to the service endpoint
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
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
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
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
adminState (optional)
String The administrative state required for the service
MAINTENANCE
DOWN
UP
autobind (optional)
String The type of autobind to be used for the service
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
inclusiveExclusive (optional)
String Whether the list item is inclusive or exclusive.
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.
lagId (optional)
lagMembers (optional)
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
adminState (optional)
String The current administrative state of the entity
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
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
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
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)
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
MOD_SP_QPSK
MOD_QPSK
MOD_8QAM
MOD_16QAM
MOD_BPSK
phaseEncoding (optional)
String Specifies the encoding type of the optical signal
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.
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.
SBR
GR
None
reversionMode (optional)
String Specifies how the path switches from the recovery to the the working path previously under failure condition.
softauto
auto
manual
sources (optional)
waveshape (optional)
String Specifies the shape of the optical signal to be used
single
_super
alien
monitorBandwidth (optional)
Boolean Specifies whether or not the bandwidth utilization of the service will be monitored
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
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
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
phase (optional)
String The phase of the life cycle object
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
Delete
DeploymentFailed
PartiallyDeployed
WaitingForDeployment
Deploying
RoutedAndSaved
Undeployed
RoutingFailed
Routing
Undeploy
Deployed
Planned
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)
latency (optional)
Double The latency of the physical link in microseconds
teLinkConfigAttributes (optional)
templateAttributes (optional)
name (optional)
template (optional)
administrativeStatus (optional)
String The LLDP administrative status for the port
DISABLED
TX_ONLY
TX_AND_RX
RX_ONLY
configurationType (optional)
String Whether this configuration is for Nearest Bridge, Nearest Customer, or Nearest Non TPMR
NEAREST_NON_TPMR
NEAREST_CUSTOMER
NEAREST_BRIDGE
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
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)
NEAREST_NON_TPMR
NEAREST_CUSTOMER
NEAREST_BRIDGE
remotePortId (optional)
String A string identifying the remote port
remotePortIdType (optional)
String The remote port id type
INTERFACE_ALIAS
INTERFACE_NAME
NETWORK_ADDRESS
LOCAL
PORT_COMPONENT
AGENT_CIRCUIT_ID
MAC_ADDRESS
remoteSystemName (optional)
String The name of the remote system
adminState (optional)
String The current administrative state of the entity
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)
name (optional)
String The name of the endpoint
primaryAddress (optional)
IpPrefix The primary IP address assigned to the service loopBack endpoint
performanceMetricAttributes (optional)
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)
monitoredRouterId (optional)
String The unique identifier of the monitored router for this port
name (optional)
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)
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
nextHopBundleId (optional)
String The unique identifier of the next hop bundle
portId (optional)
String The unique identifier for the network element port
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)
neId (optional)
String The unique identifier for the corresponding network element router
routerIpAddress (optional)
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
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
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
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)
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
baseMacAddress (optional)
String The base MAC address for the network element
customProperties (optional)
geoLocation (optional)
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
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
network (optional)
teTopologiesAugment (optional)
id (optional)
String The unique identifier for the bundle
name (optional)
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
nextHopRouterIpAddress (optional)
IpAddress The bundle's next hop's router IP address
isVip (optional)
Boolean Indicates this bundle is for VIP steering
name (optional)
isVip (optional)
Boolean Indicates this bundle is for VIP steering
name (optional)
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
nextHopRouterIpAddress (optional)
IpAddress The bundle's next hop's router IP address
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
supportingNode (optional)
nodeId (optional)
NodeId Identifies a node uniquely within the containing network.
terminationPoint (optional)
teNodeAugment (optional)
teNodeConfigAttributesTemplate (optional)
templateAttributes (optional)
name (optional)
template (optional)
performanceMetricNormalityAttributes (optional)
asNumber (optional)
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)
interfaceId (optional)
Long The interface identifier
routerId (optional)
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)
regenInterfaceIds (optional)
regenLoose (optional)
Boolean Specifies if this constraint is strict or loose
regenRouterId (optional)
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
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
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
TE_METRIC
COST
DISTANCE
STAR_WEIGHT
LATENCY
HOPS
restoration (optional)
String Specifies the recovery technique of a path after failure.
SBR
GR
None
reversionMode (optional)
String Specifies how the path switches from the recovery to the the working path previously under failure condition.
softauto
auto
manual
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
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
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
actionType (optional)
OUT_PORT
EXPERIMENTER
experimenterActionType (optional)
String Type of the experimenter action. Applicable only for experimenter actions
REDIRECT_TO_NEXTHOP
REDIRECT_TO_SVCT
ipAddress (optional)
portId (optional)
Long Openflow switch output port id
sdpId (optional)
vcId (optional)
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
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
PENDING_DELETE
DEPLOYED
NO_ACTION
DELETED
PENDING_CREATE
PENDING_MODIFICATION
openflowInstruction (optional)
openflowMatch (optional)
priority (optional)
Long The priority of the flow
tableId (optional)
Long The table id number within the switch
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)
openflowMatch (optional)
priority (optional)
Long The priority of the flow
tableId (optional)
Long The table id number within the switch
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)
priority (optional)
Long The priority of the flow
tableId (optional)
Long The table id number within the switch
actions (optional)
instructionType (optional)
String Type of the instruction
CLEAR_ACTIONS
APPLY_ACTIONS
WRITE_ACTIONS
destIpAddress (optional)
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)
sourcePort (optional)
Long Source (TCP or UDP) port number
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)
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
V140
V150
V10
V200
V131
V130
serialNumber (optional)
String Serial number of this switch
status (optional)
DOWN
ACTIVE
UNKNOWN
swDescription (optional)
String Description of this switch
switchAddress (optional)
vendorType (optional)
OTHER
NOKIA
ALCATEL
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
protectionType (optional)
String Specifies the protection type of the port
working
protection
adminState (optional)
String The current administrative state of the entity
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
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
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
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)
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
MOD_SP_QPSK
MOD_QPSK
MOD_8QAM
MOD_16QAM
MOD_BPSK
phaseEncoding (optional)
String Specifies the encoding type of the optical signal
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.
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.
SBR
GR
None
reversionMode (optional)
String Specifies how the path switches from the recovery to the the working path previously under failure condition.
softauto
auto
manual
sources (optional)
waveshape (optional)
String Specifies the shape of the optical signal to be used
single
_super
alien
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
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
SYMMETRIC_LOOSE
NO
ASYMMETRIC_STRICT
ASYMMETRIC_LOOSE
ANY_REVERSE_ROUTE
SYMMETRIC_STRICT
disjoint (optional)
String The Disjoint Mode to be used in path computation
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
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
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)
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.
unidirectionalAvailableBandwidth (optional)
String Available bandwidth normality.
normal
abnormal
unknown
unidirectionalDelay (optional)
normal
abnormal
unknown
unidirectionalDelayVariation (optional)
String Delay variation normality.
normal
abnormal
unknown
unidirectionalMaxDelay (optional)
String Maximum delay or latency normality.
normal
abnormal
unknown
unidirectionalMinDelay (optional)
String Minimum delay or latency normality.
normal
abnormal
unknown
unidirectionalPacketLoss (optional)
normal
abnormal
unknown
unidirectionalResidualBandwidth (optional)
String Residual bandwidth normality.
normal
abnormal
unknown
unidirectionalUtilizedBandwidth (optional)
String Bandwidth utilization normality.
normal
abnormal
unknown
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.
performanceMetricThrottle (optional)
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
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
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.
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
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)
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
UNI
NNI
tdm (optional)
Tdm Contains TDM DS1/E1 interface related configuration
protectionType (optional)
String Specifies the protection type of the port. This only applies to client optical ports.
working
protection
timestamp (optional)
utilization (optional)
Double Port utilization as a percentage
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)
egressQueueConfigurationTable (optional)
externalIds (optional)
ingressCosMappingTable (optional)
ingressParam (optional)
ingressQueueConfigurationTable (optional)
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)
egressQueueOverride (optional)
ingressParam (optional)
ingressQueueOverride (optional)
qosProfile (optional)
Long The ID of the default Generic QoS profile associated with the quality of service template
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)
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.
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
kbps
percent
protectionStatus (optional)
reversion_failed
normal
reversion_started
recovery_unavailable
recovery_admin
recovery_succeeded
recovery_failed
recovery_started
wait_to_restore
restorationStatus (optional)
reversion_failed
normal
reversion_started
recovery_unavailable
recovery_admin
recovery_succeeded
recovery_failed
recovery_started
wait_to_restore
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
status (optional)
startRow (optional)
endRow (optional)
totalRows (optional)
data (optional)
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
import_export
exp
imp
systemId (optional)
systemName (optional)
appId (optional)
String The client-defined custom Application ID for this object
name (optional)
String The name of the template
pccAddress (optional)
routerInfos (optional)
id (optional)
String The unique identifier of the template
objectDescription (optional)
String The description for this object
bgpLsId (optional)
Long BGP-LS topology identifier.
protocol (optional)
String The protocol which IGP router is using
OSPFv2
ISIS
ANY
networkIdentifier (optional)
routerId (optional)
asNumber (optional)
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)
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
kbps
percent
schedulerType (optional)
String The type of the scheduler override. Default is Scheduler.
Scheduler
Arbiter
schedules (optional)
SchedulesMember Container of a schedule list defining when a particular configuration takes effect.
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
edges (optional)
endpointGrouping (optional)
groupConnections (optional)
topoName (optional)
String The name of the topology
adminState (optional)
String The current administrative state of the entity
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
DEPLOYED
FAILED
PENDING
UNKNOWN
operationalState (optional)
String The current operational state of the entity
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
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
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
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
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)
steeringParameters (optional)
underlyingTransport (optional)
String The transport of the tunnel
VXLAN
IPV4
L2TPV3
GRE
UNKNOWN
VLAN
ANY
MPLS
availableBw (optional)
Long Specifies the available bandwidth on the service
ownership (optional)
Ownership Specifies ownership model of this tunnel
steeringParameters (optional)
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
sourceNode (optional)
String Source node identifier, must be in same topology.
sourceTp (optional)
String Termination point within source node that terminates the link.
teLinkConfig (optional)
teLinkStateDerived (optional)
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
next_hop
targetIpAddress (optional)
IpAddress The target IP address. This would represent the next-hop address.
nextHopIpAddress (optional)
IpAddress The IP address of the bundle's next hop
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.
networkRef (optional)
String References the underlay network that the underlay node is part of.
nodeRef (optional)
String References the underlay node itself.
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
channelFraming (optional)
String Specifies the channel framing configuration for the DS1/E1 port
ds0ChannelGroups (optional)
signalMode (optional)
SIGNAL_MODE_CAS
SIGNAL_MODE_NONE
adminState (optional)
String The current administrative state of this DS0 channel group
MAINTENANCE
DOWN
UP
encapType (optional)
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
PARTIALLY_DOWN
TRANSITION
DOWN
UNKNOWN
UP
timeSlots (optional)
String The time-slots configured on the DS0 channel group
adminState (optional)
String The current administrative state of the entity
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)
name (optional)
String The name of the endpoint
siteServiceQosProfile (optional)
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
config (optional)
state (optional)
State Operational state data.
accessType (optional)
String Link access type, which can be point-to-point or multi-access.
point_to_point
multi_access
adminStatus (optional)
String The administrative state of the link.
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)
performanceMetricThrottleContainer (optional)
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
teLinkInfoAttributes (optional)
underlay (optional)
Underlay Attributes of the te-link underlay.
teLinkAttributes (optional)
componentLinks (optional)
bundledLinks (optional)
teLinkTemplate (optional)
template (optional)
teLinkAttributes (optional)
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)
teDefaultMetric (optional)
Long Traffic Engineering Metric.
teSrlgs (optional)
unreservedBandwidth (optional)
interfaceSwitchingCapabilityList (optional)
teLinkConnectivityAttributes (optional)
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.
enhanced
extra_traffic
shared
_1_plus_1
unprotected
_1_for_1
informationSource (optional)
String Indicates the source of the information.
other
locally_configured
ospfv2
isis
ospfv3
system_processed
unknown
informationSourceState (optional)
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.
testing
up
preparing_maintenance
down
maintenance
unknown
recovery (optional)
Recovery Status of the recovery process.
underlay (optional)
teLinkStateUnderlayAttributes (optional)
teTopologyHierarchy (optional)
underlayBackupPath (optional)
underlayPrimaryPath (optional)
underlayProtectionType (optional)
Integer Underlay protection type desired for this link
underlayTrailDes (optional)
underlayTrailSrc (optional)
adminStatus (optional)
String The administrative state of the link.
testing
up
preparing_maintenance
down
maintenance
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
teNodeConnectivityMatrix (optional)
teNodeInfoAttributes (optional)
config (optional)
state (optional)
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)
teNodeConfig (optional)
teNodeStateDerived (optional)
teNodeAttributes (optional)
teNodeTemplate (optional)
template (optional)
teNodeAttributes (optional)
adminStatus (optional)
String The administrative state of the link.
testing
up
preparing_maintenance
down
maintenance
schedules (optional)
Schedules A list of schedules defining when a particular configuration takes effect.
teNodeInfoAttributes (optional)
connectivityMatrix (optional)
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)
signalingAddress (optional)
underlayTopology (optional)
UnderlayTopology When an abstract node encapsulates a topology, the attributes in this container point to said topology.
informationSource (optional)
String Indicates the source of the information.
other
locally_configured
ospfv2
isis
ospfv3
system_processed
unknown
informationSourceState (optional)
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.
testing
up
preparing_maintenance
down
maintenance
unknown
informationSourceAttributes (optional)
teNodeConnectivityMatrix (optional)
teNodeInfoAttributes (optional)
encoding (optional)
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)
terminationCapability (optional)
asNumber (optional)
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)
interfaceId (optional)
Long The interface identifier
routerId (optional)
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
config (optional)
state (optional)
teTpId (optional)
TeTpId An identifier to uniquely identify a TE termination point.
teTerminationPointConfig (optional)
teTerminationPointConfig (optional)
interfaceSwitchingCapabilityList (optional)
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.
templates (optional)
Templates Configuration parameters for templates used for TE topology.
clientId (optional)
TeGlobalId An identifier to uniquely identify a client.
config (optional)
providerId (optional)
TeGlobalId An identifier to uniquely identify a provider.
state (optional)
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.
teTopologyConfig (optional)
teTopologyConfig (optional)
schedules (optional)
SchedulesMember Container of a schedule list defining when a particular configuration takes effect.
optimizationCriterion (optional)
preference (optional)
Integer Specifies a preference for this topology. A lower number indicates a higher preference.
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.
ipAddress (optional)
uint32 (optional)
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.
no_action
cascade
not_allowed
linkTemplate (optional)
nodeTemplate (optional)
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)
labelRestriction (optional)
maxLspBandwidth (optional)
linkTp (optional)
String Link termination point.
supportingTerminationPoint (optional)
tpId (optional)
TpId Termination point identifier.
performanceMetricAttributes (optional)
performanceMetricAttributes (optional)
performanceMetricAttributes (optional)
indication (optional)
String Indication whether the interface supports Standard or Arbitrary SONET/SDH
standard
arbitrary
minimumLspBandwidth (optional)
Double Minimum LSP Bandwidth. Units in bytes per second.
tpRef (optional)
String Relative reference to destination termination point.
serviceTopology (optional)
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.)
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.
SECONDARY
STANDBY
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
teNodeTunnelTerminationCapability (optional)
tunnelTpId (optional)
teLinkUnderlayAttributes (optional)
teTopologyHierarchy (optional)
teLinkStateUnderlayAttributes (optional)
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.
pathElement (optional)
teTopologyRef (optional)
teTopologyHierarchy (optional)
teTopologyRef (optional)
tpRef (optional)
TpRef References a termination point in a specific node.
tpRef (optional)
TpRef References a termination point in a specific node.
id (optional)
String The user unique identifier
name (optional)
password (optional)
String The password for the user
userName (optional)
nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to
bandwidth (optional)
customerId (optional)
String The unique identifier for the VIP customer
subnetsBandwidth (optional)
bandwidth (optional)
customerId (optional)
String The unique identifier for the VIP customer
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)
subnetCount (optional)
Long Number of subnets on this customer
customerId (optional)
String The unique identifier for the VIP customer
state (optional)
ACTIVE
PENDING
steeredSubnetCount (optional)
Long The number of subnets steered
subnetsSteeringEntry (optional)
bandwidth (optional)
subnetId (optional)
String The unique identifier for the VIP subnet
id (optional)
String The unique identifier for the VIP subnet
subnetPrefix (optional)
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)
vipSubnetId (optional)
String The unique identifier for the VIP subnet
nextHopIpAddress (optional)
IpAddress The IP address of the next hop to steer to
vipSubnetId (optional)
String The unique identifier for the VIP subnet