| Method Signature |
Description |
Path |
Workflow? |
| getApplicationId(id, callback) |
Find an object by Application ID |
{base_path}/{version}/v4/generic/application-id/{pathv1}?{query} |
Yes |
| setApplicationId(appId, id, callback) |
Set an object Application ID |
{base_path}/{version}/v4/generic/application-id/{pathv1}/{pathv2}?{query} |
Yes |
| getConsumed(uuid, callback) |
Find all objects being consumed by an object |
{base_path}/{version}/v4/generic/consumed/{pathv1}?{query} |
Yes |
| findByExternalId(body, callback) |
Find the unique identifier of an object given an external identifier |
{base_path}/{version}/v4/generic/find-by-external-id?{query} |
Yes |
| getTenants(uuid, callback) |
Find all tenants assigned to an object |
{base_path}/{version}/v4/generic/tenants/{pathv1}?{query} |
Yes |
| get(uuid, callback) |
Find an object by a unique identifier |
{base_path}/{version}/v4/generic/{pathv1}?{query} |
Yes |
| addL2BackhaulEndpoint(body, serviceUuid, callback) |
Add an endpoint to a L2 Backhaul Service |
{base_path}/{version}/v4/ietf/ethtsvc/l2-backhaul/{pathv1}/endpoint?{query} |
Yes |
| updateL2BackhaulEndpoint(endpointUuid, body, serviceUuid, callback) |
Update endpoint of a L2 Backhaul service |
{base_path}/{version}/v4/ietf/ethtsvc/l2-backhaul/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| patchL2BackhaulEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch endpoint of an L3 VPN service |
{base_path}/{version}/v4/ietf/ethtsvc/l2-backhaul/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| createL2backhaul(autoPath, body, callback) |
Create L2 Backhaul Service |
{base_path}/{version}/v4/ietf/ethtsvc/l2backhaul/{pathv1}?{query} |
Yes |
| updateL2backhaul(body, serviceUuid, callback) |
Modify L2 Backhaul service |
{base_path}/{version}/v4/ietf/ethtsvc/l2backhaul/{pathv1}?{query} |
Yes |
| patchL2backhaul(body, serviceUuid, callback) |
Patch L2 Backhaul service |
{base_path}/{version}/v4/ietf/ethtsvc/l2backhaul/{pathv1}?{query} |
Yes |
| getV4Services(callback) |
Query all service objects |
{base_path}/{version}/v4/services?{query} |
Yes |
| createClines(body, callback) |
Create a C-Line service |
{base_path}/{version}/v4/services/clines?{query} |
Yes |
| updateClines(body, serviceUuid, callback) |
Modify a C-Line service |
{base_path}/{version}/v4/services/clines/{pathv1}?{query} |
Yes |
| patchClines(body, serviceUuid, callback) |
Patch a C-Line service |
{base_path}/{version}/v4/services/clines/{pathv1}?{query} |
Yes |
| updateClineEndpoint(endpointUuid, serviceUuid, body, callback) |
Update the endpoint of a C-Line service |
{base_path}/{version}/v4/services/clines/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| patchClineEndpoint(endpointUuid, serviceUuid, body, callback) |
Patch the endpoint of a C-Line service |
{base_path}/{version}/v4/services/clines/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| getComponents(uuid, callback) |
Retrieve inventory of service endpoints, tunnels, and physical links for the requested service UUID |
{base_path}/{version}/v4/services/components/{pathv1}?{query} |
Yes |
| createEaccess(body, callback) |
Create an IP E-Access service |
{base_path}/{version}/v4/services/eaccess?{query} |
Yes |
| updateEaccess(body, serviceUuid, callback) |
Modify an IP E-Access service |
{base_path}/{version}/v4/services/eaccess/{pathv1}?{query} |
Yes |
| patchEaccess(body, serviceUuid, callback) |
Patch an IP E-Access service |
{base_path}/{version}/v4/services/eaccess/{pathv1}?{query} |
Yes |
| createElans(body, callback) |
Create an E-LAN VPN service |
{base_path}/{version}/v4/services/elans?{query} |
Yes |
| updateElans(body, serviceUuid, callback) |
Modify an E-LAN service |
{base_path}/{version}/v4/services/elans/{pathv1}?{query} |
Yes |
| patchElans(body, serviceUuid, callback) |
Patch an E-LAN service |
{base_path}/{version}/v4/services/elans/{pathv1}?{query} |
Yes |
| addElanEndpoint(body, serviceUuid, callback) |
Add an endpoint to an E-LAN service |
{base_path}/{version}/v4/services/elans/{pathv1}/endpoint?{query} |
Yes |
| updateElanEndpoint(endpointUuid, body, serviceUuid, callback) |
Update the endpoint of an E-LAN service |
{base_path}/{version}/v4/services/elans/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| patchElanEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch the endpoint of an E-LAN service |
{base_path}/{version}/v4/services/elans/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| createElines(body, callback) |
Create an IP or optical E-Line service |
{base_path}/{version}/v4/services/elines?{query} |
Yes |
| updateElines(body, serviceUuid, callback) |
Modify an IP or optical E-Line service |
{base_path}/{version}/v4/services/elines/{pathv1}?{query} |
Yes |
| patchElines(body, serviceUuid, callback) |
Patch an IP or optical E-Line service |
{base_path}/{version}/v4/services/elines/{pathv1}?{query} |
Yes |
| updateElineEndpoint(endpointUuid, body, serviceUuid, callback) |
Update the endpoint of an E-Line service |
{base_path}/{version}/v4/services/elines/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| patchElineEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch the endpoint of an E-Line service |
{base_path}/{version}/v4/services/elines/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| updateFixL3VpnVrfMembership(serviceUuid, callback) |
Sites within the specified L3-VPN service that are not correctly connected by VRF membership will b |
{base_path}/{version}/v4/services/fix-l3-vpn-vrf-membership/{pathv1}?{query} |
Yes |
| createIes(body, callback) |
Create an IP IES service |
{base_path}/{version}/v4/services/ies?{query} |
Yes |
| updateIes(body, serviceUuid, callback) |
Modify an IP IES service |
{base_path}/{version}/v4/services/ies/{pathv1}?{query} |
Yes |
| patchIes(body, serviceUuid, callback) |
Patch an IP IES service |
{base_path}/{version}/v4/services/ies/{pathv1}?{query} |
Yes |
| addIesEndpoint(body, serviceUuid, callback) |
Add an endpoint to a IES service |
{base_path}/{version}/v4/services/ies/{pathv1}/endpoint?{query} |
Yes |
| updateIesEndpoint(endpointUuid, body, serviceUuid, callback) |
Update the endpoint of an IES service |
{base_path}/{version}/v4/services/ies/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| patchIesEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch the endpoint of an IES service |
{base_path}/{version}/v4/services/ies/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| addIesLoopbackEndpoint(body, serviceUuid, callback) |
Add a loop back endpoint to an IES service |
{base_path}/{version}/v4/services/ies/{pathv1}/loopback-endpoint?{query} |
Yes |
| updateIesLoopbackEndpoint(endpointUuid, body, serviceUuid, callback) |
Update loop back endpoint of an IES service |
{base_path}/{version}/v4/services/ies/{pathv1}/loopback-endpoint/{pathv2}?{query} |
Yes |
| patchIesLoopbackEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch loop back endpoint of an IES service |
{base_path}/{version}/v4/services/ies/{pathv1}/loopback-endpoint/{pathv2}?{query} |
Yes |
| createL3DciVpns(body, callback) |
Support for limited Data Center use cases as VXLAN Stitched connectivity type. Unsupported Proof of |
{base_path}/{version}/v4/services/l3-dci-vpns?{query} |
Yes |
| patchL3DciL3Endpoint(endpointUuid, body, serviceUuid, callback) |
Patch L3 endpoint of an L3 DCI service |
{base_path}/{version}/v4/services/l3-dcis/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| getL3VpnRtAudit(callback) |
Runs an audit to find all L3-VPN services with invalid VRF membership. Currently the audit only con |
{base_path}/{version}/v4/services/l3-vpn-rt-audit?{query} |
Yes |
| createL3Vpns(body, callback) |
Create an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns?{query} |
Yes |
| updateL3Vpns(body, serviceUuid, callback) |
Modify an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}?{query} |
Yes |
| patchL3Vpns(body, serviceUuid, callback) |
Patch an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}?{query} |
Yes |
| addL3VpnEndpoint(body, serviceUuid, callback) |
Add an endpoint to an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}/endpoint?{query} |
Yes |
| updateL3VpnEndpoint(endpointUuid, body, serviceUuid, callback) |
Update endpoint of an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| patchL3VpnEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch endpoint of an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| addL3VpnLoopbackEndpoint(body, serviceUuid, callback) |
Add a loop back endpoint to an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}/loopback-endpoint?{query} |
Yes |
| updateL3VpnLoopbackEndpoint(endpointUuid, body, serviceUuid, callback) |
Update loop back endpoint of an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}/loopback-endpoint/{pathv2}?{query} |
Yes |
| patchL3VpnLoopbackEndpoint(endpointUuid, body, serviceUuid, callback) |
Patch loop back endpoint of an L3 VPN service |
{base_path}/{version}/v4/services/l3-vpns/{pathv1}/loopback-endpoint/{pathv2}?{query} |
Yes |
| createLags(body, callback) |
Create a LAG service |
{base_path}/{version}/v4/services/lags?{query} |
Yes |
| updateLags(body, serviceUuid, callback) |
Modify an LAG service |
{base_path}/{version}/v4/services/lags/{pathv1}?{query} |
Yes |
| createNormalizedL3Vpns(body, callback) |
Create a normalized L3 VPN service |
{base_path}/{version}/v4/services/normalized-l3-vpns?{query} |
Yes |
| updateNormalizedL3Vpns(body, serviceUuid, callback) |
Modify a normalized L3 VPN service |
{base_path}/{version}/v4/services/normalized-l3-vpns/{pathv1}?{query} |
Yes |
| patchNormalizedL3Vpns(body, serviceUuid, callback) |
Patch a normalized L3 VPN service |
{base_path}/{version}/v4/services/normalized-l3-vpns/{pathv1}?{query} |
Yes |
| addL3VpnNormalizedEndpoint(body, serviceUuid, callback) |
Add an endpoint to a normalized L3 VPN service |
{base_path}/{version}/v4/services/normalized-l3-vpns/{pathv1}/endpoint?{query} |
Yes |
| createOptical(body, callback) |
Create or modify an optical service |
{base_path}/{version}/v4/services/optical?{query} |
Yes |
| updateOptical(body, serviceUuid, callback) |
Modify an optical service |
{base_path}/{version}/v4/services/optical/{pathv1}?{query} |
Yes |
| patchOptical(body, serviceUuid, callback) |
Patch an optical service |
{base_path}/{version}/v4/services/optical/{pathv1}?{query} |
Yes |
| getPhysicalLinksOnService(serviceUuid, callback) |
Query physical links used by service |
{base_path}/{version}/v4/services/physical-links-on-service/{pathv1}?{query} |
Yes |
| getResourceCount(resourceType = 'EACCESS_SERVICE', tenantUuid, callback) |
getResourceCount |
{base_path}/{version}/v4/services/resource-count/{pathv1}/{pathv2}?{query} |
Yes |
| getServicesOnTunnel(tunnelUuid, callback) |
Query services using a tunnel |
{base_path}/{version}/v4/services/services-on-tunnel/{pathv1}?{query} |
Yes |
| getV4ServicesTenantUuid(uuid, callback) |
getTenant |
{base_path}/{version}/v4/services/tenant/{pathv1}?{query} |
Yes |
| getTunnel(tunnelUuid, callback) |
Find a Tunnel |
{base_path}/{version}/v4/services/tunnel/{pathv1}?{query} |
Yes |
| updateTunnel(body, tunnelUuid, callback) |
Modify a tunnel |
{base_path}/{version}/v4/services/tunnel/{pathv1}?{query} |
Yes |
| getTunnels(callback) |
Query all Tunnels |
{base_path}/{version}/v4/services/tunnels?{query} |
Yes |
| getTunnelsOnService(serviceUuid, callback) |
Query service tunnels used by service |
{base_path}/{version}/v4/services/tunnels-on-service/{pathv1}?{query} |
Yes |
| deleteServiceEndpoint(endpointUuid, serviceUuid, callback) |
Delete a service endpoint from a service |
{base_path}/{version}/v4/services/{pathv1}/endpoint/{pathv2}?{query} |
Yes |
| getEndpoints(serviceUuid, callback) |
Query all endpoints associated to a service object |
{base_path}/{version}/v4/services/{pathv1}/endpoints?{query} |
Yes |
| getV4ServicesUuid(uuid, callback) |
Find a service by a unique identifier |
{base_path}/{version}/v4/services/{pathv1}?{query} |
Yes |
| deleteV4ServicesUuid(uuid, callback) |
Delete a service |
{base_path}/{version}/v4/services/{pathv1}?{query} |
Yes |
| getLink(linkId, callback) |
Get TE link. A link has a UUID, attributes, a source (node, termination-point) and a destination (n |
{base_path}/{version}/v4/ietf/te/link/{pathv1}?{query} |
Yes |
| patchLink(linkUuid, body, callback) |
Patch TE link by updating the configuration parameters. Supported configuration parameter(s): SRLG, |
{base_path}/{version}/v4/ietf/te/link/{pathv1}?{query} |
Yes |
| getNetwork(networkId, callback) |
Get TE network. A network has a UUID, attributes, a list of nodes and a list of links. |
{base_path}/{version}/v4/ietf/te/network/{pathv1}?{query} |
Yes |
| getNetworks(callback) |
Get TE networks. A list of networks where each network has a UUID. |
{base_path}/{version}/v4/ietf/te/networks?{query} |
Yes |
| getNode(nodeId, callback) |
Get TE node. A node has a UUID, attributes and a list of termination-points. |
{base_path}/{version}/v4/ietf/te/node/{pathv1}?{query} |
Yes |
| getTerminationPoint(tpId, callback) |
Get TE termination-point. A termination-point has a UUID and attributes. |
{base_path}/{version}/v4/ietf/te/termination-point/{pathv1}?{query} |
Yes |
| getL2Paths(body, callback) |
Get L2 Path |
{base_path}/{version}/v4/l2/backhaul/paths/l2-paths?{query} |
Yes |
| getAmiVersionTemplates(callback) |
Fetch the template global names for all AMIs, grouped by AMI |
{base_path}/{version}/v4/mediation/ami-version-templates?{query} |
Yes |
| getAmisVersions(callback) |
Fetch the AMIs and the versions. |
{base_path}/{version}/v4/mediation/amis-versions?{query} |
Yes |
| getAllAugmentationMeta(callback) |
Query all Augmentation Meta Infos |
{base_path}/{version}/v4/mediation/augmentation-meta?{query} |
Yes |
| createAugmentationMeta(body, callback) |
Create an Augmentation Meta |
{base_path}/{version}/v4/mediation/augmentation-meta?{query} |
Yes |
| updateAugmentationMeta(body, id, callback) |
Modify an Augmentation Meta |
{base_path}/{version}/v4/mediation/augmentation-meta/{pathv1}?{query} |
Yes |
| deleteAugmentationMeta(id, callback) |
Delete an Augmentation meta |
{base_path}/{version}/v4/mediation/augmentation-meta/{pathv1}?{query} |
Yes |
| getMediationAugmentation(body, callback) |
This action is to fetch the meta information of the passthrough attributes that could be provided d |
{base_path}/{version}/v4/mediation/mediation-augmentation?{query} |
Yes |
| fetchLspList(body, callback) |
Fetch RSVP or SR-TE LSP list which discovered by SDN through device management NFMP or MDM |
{base_path}/{version}/v4/mpls/lsp-list?{query} |
Yes |
| createLspPath(body, callback) |
Asynchronous API to create MPLS LSP path (PCE Initiated only) |
{base_path}/{version}/v4/mpls/lsp-path?{query} |
Yes |
| fetchLspPathList(body, callback) |
Fetch MPLS LSP path list |
{base_path}/{version}/v4/mpls/lsp-path-list?{query} |
Yes |
| getLspPath(pathId, callback) |
Get MPLS LSP path |
{base_path}/{version}/v4/mpls/lsp-path/{pathv1}?{query} |
Yes |
| deleteLspPath(pathId, callback) |
Asynchronous API to delete MPLS LSP path(PCE Initiated only) |
{base_path}/{version}/v4/mpls/lsp-path/{pathv1}?{query} |
Yes |
| patchLspPath(body, pathId, callback) |
Asynchronous API to patch PCE Initiated MPLS LSP path config and add/remove path profile override |
{base_path}/{version}/v4/mpls/lsp-path/{pathv1}?{query} |
Yes |
| getLspPaths(callback) |
Get MPLS LSP paths |
{base_path}/{version}/v4/mpls/lsp-paths?{query} |
Yes |
| createLspPaths(body, callback) |
Asynchronous API to create MPLS LSP paths(PCE Initiated only) |
{base_path}/{version}/v4/mpls/lsp-paths?{query} |
Yes |
| deleteLspPaths(body, callback) |
Asynchronous API to delete MPLS LSP paths(PCE Initiated only). List maximum size is 500. |
{base_path}/{version}/v4/mpls/lsp-paths?{query} |
Yes |
| getLspPathsPaginated(limit, page, callback) |
Get MPLS LSP paths |
{base_path}/{version}/v4/mpls/lsp-paths-paginated/{pathv1}/{pathv2}?{query} |
Yes |
| getLsp(lspId, callback) |
Get RSVP or SR-TE LSP which discovered by SDN through device management NFMP or MDM |
{base_path}/{version}/v4/mpls/lsp/{pathv1}?{query} |
Yes |
| getLsps(callback) |
Get RSVP or SR-TE LSPs which discovered by SDN through device management NFMP or MDM |
{base_path}/{version}/v4/mpls/lsps?{query} |
Yes |
| createOptimization(body, callback) |
Trigger global concurrent optimization on PCEP LSP paths |
{base_path}/{version}/v4/mpls/optimization?{query} |
Yes |
| createResignal(body, callback) |
Trigger resignal on a list of PCEP LSP paths |
{base_path}/{version}/v4/mpls/resignal?{query} |
Yes |
| getOnLink(linkId, requestType = 'MOVED', callback) |
Get MPLS LSP paths on link |
{base_path}/{version}/v4/mpls/lsp/paths/on-link/{pathv1}/{pathv2}?{query} |
Yes |
| gets(callback) |
Query all Network Elements |
{base_path}/{version}/v4/ne?{query} |
Yes |
| getSystem(systemId, callback) |
Query a unique identifier for a Network Element by System ID |
{base_path}/{version}/v4/ne/system/{pathv1}?{query} |
Yes |
| update(id, body, callback) |
Update Network Element capabilities |
{base_path}/{version}/v4/ne/{pathv1}?{query} |
Yes |
| getV4NeUuid(uuid, callback) |
Find a network element by a unique identifier |
{base_path}/{version}/v4/ne/{pathv1}?{query} |
Yes |
| getLatency(callback) |
Get NSP latency parameters |
{base_path}/{version}/v4/nsp/configuration/latency?{query} |
Yes |
| patchLatency(body, callback) |
Patch NSP latency parameters |
{base_path}/{version}/v4/nsp/configuration/latency?{query} |
Yes |
| deleteLatency(session, callback) |
API used to delete twamp tests. |
{base_path}/{version}/v4/nsp/configuration/latency/{pathv1}?{query} |
Yes |
| getTcaConfigPolicy(callback) |
Get TCA Policy configuration. Policies configuration include list of policies and collection enable |
{base_path}/{version}/v4/nsp/configuration/tca-config-policy?{query} |
Yes |
| patchTcaConfigPolicy(body, callback) |
Patch a TCA configuration policy by updating the parameters |
{base_path}/{version}/v4/nsp/configuration/tca-config-policy?{query} |
Yes |
| getTrafficDataCollection(callback) |
Get NSP traffic collection parameters. |
{base_path}/{version}/v4/nsp/configuration/traffic-data-collection?{query} |
Yes |
| patchTrafficDataCollection(body, callback) |
Patch NSP traffic-collection parameters. |
{base_path}/{version}/v4/nsp/configuration/traffic-data-collection?{query} |
Yes |
| getLinkTp(tpId, callback) |
Get link connected to the given termination point. The link may be a source or destination on the t |
{base_path}/{version}/v4/nsp/net/l3/link/tp/{pathv1}?{query} |
Yes |
| getV4NspNetL3LinkLinkId(linkId, callback) |
Get link. A link has a UUID, attributes, a source (node, termination-point) and a destination (node |
{base_path}/{version}/v4/nsp/net/l3/link/{pathv1}?{query} |
Yes |
| patchV4NspNetL3LinkLinkUuid(body, linkUuid, callback) |
Patch a link by updating the configuration parameters. Configuration parameters supported are srlg- |
{base_path}/{version}/v4/nsp/net/l3/link/{pathv1}?{query} |
Yes |
| getV4NspNetL3NetworkNetworkId(networkId, callback) |
Get NSP network. A network has a UUID, attributes, a list of nodes and a list of links |
{base_path}/{version}/v4/nsp/net/l3/network/{pathv1}?{query} |
Yes |
| getV4NspNetL3Networks(callback) |
Get NSP networks. A list of networks where each network has a UUID |
{base_path}/{version}/v4/nsp/net/l3/networks?{query} |
Yes |
| getV4NspNetL3NodeNodeId(nodeId, callback) |
Get NSP node. A node has a UUID, attributes and a list of termination-points |
{base_path}/{version}/v4/nsp/net/l3/node/{pathv1}?{query} |
Yes |
| getNodesRouter(routerId, callback) |
Get NSP nodes by IGP Router ID. A node has a UUID, attributes and a list of termination-points |
{base_path}/{version}/v4/nsp/net/l3/nodes/router/{pathv1}?{query} |
Yes |
| getNodesSite(siteIp, callback) |
Get NSP nodes by Site IP. A node has a UUID, attributes and a list of termination-points |
{base_path}/{version}/v4/nsp/net/l3/nodes/site/{pathv1}?{query} |
Yes |
| getV4NspNetL3TerminationPointTpId(tpId, callback) |
Get NSP termination-point. A termination-point has a UUID and attributes |
{base_path}/{version}/v4/nsp/net/l3/termination-point/{pathv1}?{query} |
Yes |
| getTerminationPointReverse(tpId, callback) |
Get NSP reverse termination-point for a given UUID. If the UUID corresponds to a termination point |
{base_path}/{version}/v4/nsp/net/l3/termination-point/{pathv1}/reverse?{query} |
Yes |
| getTerminationPointsNodeip(ipAddress, nodeId, callback) |
Get NSP termination-point for a given node ID and IP Address |
{base_path}/{version}/v4/nsp/net/l3/termination-points/{pathv1}/{pathv2}?{query} |
Yes |
| createFlows(body, callback) |
Create flows |
{base_path}/{version}/v4/openflow/flows?{query} |
Yes |
| deleteFlows(body, callback) |
Delete flows |
{base_path}/{version}/v4/openflow/flows?{query} |
Yes |
| patchFlows(body, callback) |
Update flow instruction |
{base_path}/{version}/v4/openflow/flows?{query} |
Yes |
| getFlowsearch(body, callback) |
Query flows based on search criteria |
{base_path}/{version}/v4/openflow/flows/search?{query} |
Yes |
| getFlowsearchById(body, callback) |
Query flows based on unique identifier |
{base_path}/{version}/v4/openflow/flows/search-by-id?{query} |
Yes |
| getPorts(datapathId, callback) |
Query all ports of an openflow switch |
{base_path}/{version}/v4/openflow/ports/{pathv1}?{query} |
Yes |
| getSwitches(callback) |
Query all openflow switches |
{base_path}/{version}/v4/openflow/switches?{query} |
Yes |
| getSwitchesInRouter(neId, callback) |
Query all openflow switches in a router |
{base_path}/{version}/v4/openflow/switches/{pathv1}?{query} |
Yes |
| getTables(datapathId, callback) |
Query all tables in an openflow switch |
{base_path}/{version}/v4/openflow/tables/{pathv1}?{query} |
Yes |
| getV4Physicallinks(callback) |
Query all physical links |
{base_path}/{version}/v4/physicallinks?{query} |
Yes |
| delete(linkId, callback) |
Delete an undiscovered physical link that was defined in NSP |
{base_path}/{version}/v4/physicallinks/{pathv1}?{query} |
Yes |
| create(destId, srcId, callback) |
Define an undicovered physical link in NSP |
{base_path}/{version}/v4/physicallinks/{pathv1}/{pathv2}?{query} |
Yes |
| getV4PhysicallinksUuid(uuid, callback) |
Find a physical link by a unique identifier |
{base_path}/{version}/v4/physicallinks/{pathv1}?{query} |
Yes |
| getAllIpOpticalCorrelationPolicy(callback) |
Query all IP Optical correlation policies |
{base_path}/{version}/v4/policy/ip-optical-correlation-policiy?{query} |
Yes |
| createIpOpticalCorrelationPolicy(body, callback) |
Create an IP Optical correlation policy |
{base_path}/{version}/v4/policy/ip-optical-correlation-policy?{query} |
Yes |
| getIpOpticalCorrelationPolicy(policyId, callback) |
Query an IP Optical correlation policy |
{base_path}/{version}/v4/policy/ip-optical-correlation-policy/{pathv1}?{query} |
Yes |
| updateIpOpticalCorrelationPolicy(body, policyId, callback) |
Update an IP Optical correlation policy |
{base_path}/{version}/v4/policy/ip-optical-correlation-policy/{pathv1}?{query} |
Yes |
| deleteIpOpticalCorrelationPolicy(policyId, callback) |
Delete an IP Optical correlation policy |
{base_path}/{version}/v4/policy/ip-optical-correlation-policy/{pathv1}?{query} |
Yes |
| getAllRdRtRanges(callback) |
Query all L3VPN RT/RD policies |
{base_path}/{version}/v4/policy/rd-rt-ranges?{query} |
Yes |
| createRdRtRanges(body, callback) |
Create a L3VPN RT/RD policy |
{base_path}/{version}/v4/policy/rd-rt-ranges?{query} |
Yes |
| updateRdRtRanges(body, policyId, callback) |
Update a L3VPN RT/RD policy |
{base_path}/{version}/v4/policy/rd-rt-ranges/{pathv1}?{query} |
Yes |
| deleteRdRtRanges(policyId, callback) |
Delete an existing L3VPN RT/RD policy. |
{base_path}/{version}/v4/policy/rd-rt-ranges/{pathv1}?{query} |
Yes |
| getAllRouterPortProtectionGroupPolicy(callback) |
Query all router port protection group policies |
{base_path}/{version}/v4/policy/router-port-protection-group-policy?{query} |
Yes |
| createRouterPortProtectionGroupPolicy(body, callback) |
Create a router port protection group policy |
{base_path}/{version}/v4/policy/router-port-protection-group-policy?{query} |
Yes |
| getRouterPortProtectionGroupPolicy(policyId, callback) |
Query a router port protection group policy |
{base_path}/{version}/v4/policy/router-port-protection-group-policy/{pathv1}?{query} |
Yes |
| updateRouterPortProtectionGroupPolicy(policyId, body, callback) |
Update a router port protection group policy |
{base_path}/{version}/v4/policy/router-port-protection-group-policy/{pathv1}?{query} |
Yes |
| deleteRouterPortProtectionGroupPolicy(policyId, callback) |
Delete a router port protection group policy |
{base_path}/{version}/v4/policy/router-port-protection-group-policy/{pathv1}?{query} |
Yes |
| createSteeringParameter(body, callback) |
Create a Steering Parameter |
{base_path}/{version}/v4/policy/steering-parameter?{query} |
Yes |
| deleteSteeringParameter(steeringParameterName, callback) |
Delete a Steering Parameter |
{base_path}/{version}/v4/policy/steering-parameter/{pathv1}?{query} |
Yes |
| getSteeringParameters(callback) |
Query all Steering Paramters |
{base_path}/{version}/v4/policy/steering-parameters?{query} |
Yes |
| getAllTunnelSelections(callback) |
Query all tunnel selection policies. |
{base_path}/{version}/v4/policy/tunnel-selections?{query} |
Yes |
| createTunnelSelections(body, callback) |
Create a tunnel selection policy. |
{base_path}/{version}/v4/policy/tunnel-selections?{query} |
Yes |
| getTunnelSelections(policyId, callback) |
Query a tunnel selections policy by its unique identifier. |
{base_path}/{version}/v4/policy/tunnel-selections/{pathv1}?{query} |
Yes |
| updateTunnelSelections(policyId, body, callback) |
Update a tunnel selection policy. |
{base_path}/{version}/v4/policy/tunnel-selections/{pathv1}?{query} |
Yes |
| deleteTunnelSelections(policyId, callback) |
Delete an existing tunnel selections policy. |
{base_path}/{version}/v4/policy/tunnel-selections/{pathv1}?{query} |
Yes |
| getV4Ports(callback) |
Find all ports in the network |
{base_path}/{version}/v4/ports?{query} |
Yes |
| getNeAllByTenant(neId, tenantUuid, callback) |
getNeAllByTenant |
{base_path}/{version}/v4/ports/ne-all-by-tenant/{pathv1}/tenant/{pathv2}?{query} |
Yes |
| getNeAll(neId, callback) |
Query all ports of the provided network element |
{base_path}/{version}/v4/ports/ne-all/{pathv1}?{query} |
Yes |
| getNeByTenant(neId, serviceType = 'ODU', tenantUuid, callback) |
getNeByTenant |
{base_path}/{version}/v4/ports/ne-by-tenant/{pathv1}/servicetype/{pathv2}/tenant/{pathv3}?{query} |
Yes |
| getNe(neUuid, serviceType = 'ODU', callback) |
Query all ports of the provided network element of a service type |
{base_path}/{version}/v4/ports/ne/{pathv1}/servicetype/{pathv2}?{query} |
Yes |
| getServiceCountOnPort(portUuid, callback) |
Find number of services on a specified port |
{base_path}/{version}/v4/ports/service-count-on-port/{pathv1}?{query} |
Yes |
| getServicesOnPort(portUuid, callback) |
Query all services using a port |
{base_path}/{version}/v4/ports/services-on-port/{pathv1}?{query} |
Yes |
| getServicetype(serviceType = 'ODU', callback) |
Find all ports in the network that support a given service type |
{base_path}/{version}/v4/ports/servicetype/{pathv1}?{query} |
Yes |
| getServicetypeByTenant(serviceType = 'ODU', tenantUuid, callback) |
getServicetypeByTenant |
{base_path}/{version}/v4/ports/servicetype/{pathv1}/tenant/{pathv2}?{query} |
Yes |
| getTenant(tenantUuid, callback) |
getTenant |
{base_path}/{version}/v4/ports/tenant/{pathv1}?{query} |
Yes |
| putV4PortsId(id, body, callback) |
Update the port |
{base_path}/{version}/v4/ports/{pathv1}?{query} |
Yes |
| getV4PortsPortUuid(portUuid, callback) |
Find a port by unique identifier |
{base_path}/{version}/v4/ports/{pathv1}?{query} |
Yes |
| getAuthentication(callback) |
Retrieve information about the currently-authenticated user from the perspective of the system |
{base_path}/{version}/v4/security/authentication?{query} |
Yes |
| createConstraintTest(serviceUuid, callback) |
BETA - Run service constraint test |
{base_path}/{version}/v4/servicedebug/constraint-test/{pathv1}?{query} |
Yes |
| createDciRecompute(serviceUuid, callback) |
Triggers re-computation for a L2 or L3 DCI Service. The DCI Service types automatically react to to |
{base_path}/{version}/v4/servicedebug/dci-recompute/{pathv1}?{query} |
Yes |
| isMaster(callback) |
NSP server is master |
{base_path}/{version}/v4/system/isMaster?{query} |
Yes |
| setPluginConnect(pluginKey, pluginName = 'VSR_NRC', pluginVId, callback) |
BETA: Forces NSP Plugin to form a specific connection |
{base_path}/{version}/v4/system/plugin-connect/{pathv1}/{pathv2}/{pathv3}?{query} |
Yes |
| resyncNms(callback) |
Triggers a data synchronization with the connected NMS |
{base_path}/{version}/v4/system/resync-nms?{query} |
Yes |
| resyncObject(uuid, callback) |
Triggers a data synchronization with the connected NMS on a specific object |
{base_path}/{version}/v4/system/resync-object/{pathv1}?{query} |
Yes |
| getState(callback) |
Retrieves the state of the system |
{base_path}/{version}/v4/system/state?{query} |
Yes |
| getVersion(callback) |
Retrieves the version of the system |
{base_path}/{version}/v4/system/version?{query} |
Yes |
| getAllClineServices(callback) |
Query all C-Line service creation templates |
{base_path}/{version}/v4/template/cline-services?{query} |
Yes |
| createClineServices(body, callback) |
Create a C-Line service creation template |
{base_path}/{version}/v4/template/cline-services?{query} |
Yes |
| getClineServices(templateId, callback) |
Find a C-Line service creation template by its unique identifier |
{base_path}/{version}/v4/template/cline-services/{pathv1}?{query} |
Yes |
| updateClineServices(body, templateId, callback) |
Modify a C-Line service creation template |
{base_path}/{version}/v4/template/cline-services/{pathv1}?{query} |
Yes |
| deleteClineServices(templateId, callback) |
Delete a C-Line service creation template |
{base_path}/{version}/v4/template/cline-services/{pathv1}?{query} |
Yes |
| getAllCustomAttributes(callback) |
Query all Custom Attributes templates |
{base_path}/{version}/v4/template/custom-attributes?{query} |
Yes |
| createCustomAttributes(body, callback) |
Create a Custom Attributes template |
{base_path}/{version}/v4/template/custom-attributes?{query} |
Yes |
| getCustomAttributes(templateId, callback) |
Find a Custom Attributes template by its unique identifier |
{base_path}/{version}/v4/template/custom-attributes/{pathv1}?{query} |
Yes |
| updateCustomAttributes(body, templateId, callback) |
Modify a Custom Attributes template |
{base_path}/{version}/v4/template/custom-attributes/{pathv1}?{query} |
Yes |
| deleteCustomAttributes(templateId, callback) |
Delete a Custom Attributes template |
{base_path}/{version}/v4/template/custom-attributes/{pathv1}?{query} |
Yes |
| getAllElanServices(callback) |
Query all E-LAN service creation templates |
{base_path}/{version}/v4/template/elan-services?{query} |
Yes |
| createElanServices(body, callback) |
Create an E-LAN service creation template |
{base_path}/{version}/v4/template/elan-services?{query} |
Yes |
| getElanServices(templateId, callback) |
Find an E-LAN service creation template by its unique identifier |
{base_path}/{version}/v4/template/elan-services/{pathv1}?{query} |
Yes |
| updateElanServices(body, templateId, callback) |
Modify an E-LAN service creation template |
{base_path}/{version}/v4/template/elan-services/{pathv1}?{query} |
Yes |
| deleteElanServices(templateId, callback) |
Delete an E-LAN service creation template |
{base_path}/{version}/v4/template/elan-services/{pathv1}?{query} |
Yes |
| getAllElineServices(callback) |
Query all E-Line service creation templates |
{base_path}/{version}/v4/template/eline-services?{query} |
Yes |
| createElineServices(body, callback) |
Create an E-Line service creation template |
{base_path}/{version}/v4/template/eline-services?{query} |
Yes |
| getElineServices(templateId, callback) |
Find an E-Line service creation template by its unique identifier |
{base_path}/{version}/v4/template/eline-services/{pathv1}?{query} |
Yes |
| updateElineServices(body, templateId, callback) |
Modify an E-Line service creation template |
{base_path}/{version}/v4/template/eline-services/{pathv1}?{query} |
Yes |
| deleteElineServices(templateId, callback) |
Delete an E-Line service creation template |
{base_path}/{version}/v4/template/eline-services/{pathv1}?{query} |
Yes |
| getAllGenericQos(callback) |
Query all generic QoS profiles. |
{base_path}/{version}/v4/template/generic-qos?{query} |
Yes |
| createGenericQos(body, callback) |
Create a Generic QoS Profile |
{base_path}/{version}/v4/template/generic-qos?{query} |
Yes |
| getGenericQosProfiles(neId, callback) |
Query all generic QoS profiles of the provided network element |
{base_path}/{version}/v4/template/generic-qos-profiles/{pathv1}?{query} |
Yes |
| getGenericQos(gqpId, callback) |
Find a generic QoS profile by its unique ID |
{base_path}/{version}/v4/template/generic-qos/{pathv1}?{query} |
Yes |
| updateGenericQos(gqpId, body, callback) |
Update a Generic QoS Profile |
{base_path}/{version}/v4/template/generic-qos/{pathv1}?{query} |
Yes |
| deleteGenericQos(gqpId, callback) |
Delete a Generic QoS Profile |
{base_path}/{version}/v4/template/generic-qos/{pathv1}?{query} |
Yes |
| getAllIesServices(callback) |
Query all IES service creation templates |
{base_path}/{version}/v4/template/ies-services?{query} |
Yes |
| createIesServices(body, callback) |
Create an IES service creation template |
{base_path}/{version}/v4/template/ies-services?{query} |
Yes |
| getIesServices(templateId, callback) |
Find an IES service creation template by its unique identifier |
{base_path}/{version}/v4/template/ies-services/{pathv1}?{query} |
Yes |
| updateIesServices(body, templateId, callback) |
Modify an IES service creation template |
{base_path}/{version}/v4/template/ies-services/{pathv1}?{query} |
Yes |
| deleteIesServices(templateId, callback) |
Delete an IES service creation template |
{base_path}/{version}/v4/template/ies-services/{pathv1}?{query} |
Yes |
| getAllL2DciVpnServices(callback) |
Query all L2 DCI VPN service creation templates |
{base_path}/{version}/v4/template/l2-dci-vpn-services?{query} |
Yes |
| getL2DciVpnServices(templateId, callback) |
Find an L2 DCI VPN service creation template by its unique identifier |
{base_path}/{version}/v4/template/l2-dci-vpn-services/{pathv1}?{query} |
Yes |
| updateL2DciVpnServices(body, templateId, callback) |
Modify an L2 DCI VPN service creation template |
{base_path}/{version}/v4/template/l2-dci-vpn-services/{pathv1}?{query} |
Yes |
| getAllL2backhaulServices(callback) |
Query all L2 Backhaul service creation templates |
{base_path}/{version}/v4/template/l2backhaul-services?{query} |
Yes |
| createL2backhaulServices(body, callback) |
Create an L2 backhaul service creation template |
{base_path}/{version}/v4/template/l2backhaul-services?{query} |
Yes |
| getL2backhaulServices(templateId, callback) |
Find an L2 Backhaul service creation template by its unique identifier |
{base_path}/{version}/v4/template/l2backhaul-services/{pathv1}?{query} |
Yes |
| updateL2backhaulServices(body, templateId, callback) |
Modify an L2 Backhaul service creation template |
{base_path}/{version}/v4/template/l2backhaul-services/{pathv1}?{query} |
Yes |
| deleteL2backhaulServices(templateId, callback) |
Delete an L2 Backhaul service creation template |
{base_path}/{version}/v4/template/l2backhaul-services/{pathv1}?{query} |
Yes |
| getAllL3DciVpnServices(callback) |
Query all L3 DCI VPN service creation templates |
{base_path}/{version}/v4/template/l3-dci-vpn-services?{query} |
Yes |
| createL3DciVpnServices(body, callback) |
Create an L3 DCI VPN service creation template |
{base_path}/{version}/v4/template/l3-dci-vpn-services?{query} |
Yes |
| getL3DciVpnServices(templateId, callback) |
Find an L3 DCI VPN service creation template by its unique identifier |
{base_path}/{version}/v4/template/l3-dci-vpn-services/{pathv1}?{query} |
Yes |
| updateL3DciVpnServices(body, templateId, callback) |
Modify an L3 DCI VPN service creation template |
{base_path}/{version}/v4/template/l3-dci-vpn-services/{pathv1}?{query} |
Yes |
| deleteL3DciVpnServices(templateId, callback) |
Delete an L3 DCI VPN service creation template |
{base_path}/{version}/v4/template/l3-dci-vpn-services/{pathv1}?{query} |
Yes |
| getAllL3VpnServices(callback) |
Query all L3 VPN service creation templates |
{base_path}/{version}/v4/template/l3-vpn-services?{query} |
Yes |
| createL3VpnServices(body, callback) |
Create an L3 VPN service creation template |
{base_path}/{version}/v4/template/l3-vpn-services?{query} |
Yes |
| getL3VpnServices(templateId, callback) |
Find an L3 VPN service creation template by its unique identifier |
{base_path}/{version}/v4/template/l3-vpn-services/{pathv1}?{query} |
Yes |
| updateL3VpnServices(body, templateId, callback) |
Modify an L3 VPN service creation template |
{base_path}/{version}/v4/template/l3-vpn-services/{pathv1}?{query} |
Yes |
| deleteL3VpnServices(templateId, callback) |
Delete an L3 VPN service creation template |
{base_path}/{version}/v4/template/l3-vpn-services/{pathv1}?{query} |
Yes |
| getAllLagServices(callback) |
Query all LAG service creation templates |
{base_path}/{version}/v4/template/lag-services?{query} |
Yes |
| createLagServices(body, callback) |
Create a LAG service creation template |
{base_path}/{version}/v4/template/lag-services?{query} |
Yes |
| getLagServices(templateId, callback) |
Find a LAG service creation template by its unique identifier |
{base_path}/{version}/v4/template/lag-services/{pathv1}?{query} |
Yes |
| updateLagServices(body, templateId, callback) |
Modify a LAG service creation template |
{base_path}/{version}/v4/template/lag-services/{pathv1}?{query} |
Yes |
| deleteLagServices(templateId, callback) |
Delete a LAG service creation template |
{base_path}/{version}/v4/template/lag-services/{pathv1}?{query} |
Yes |
| createMediationProfileMapping(body, callback) |
Create an Mediation profile Mapping |
{base_path}/{version}/v4/template/mediation-profile-mapping?{query} |
Yes |
| getMediationProfileMapping(profileId, callback) |
Find a mediation profile mapping by its unique identifier |
{base_path}/{version}/v4/template/mediation-profile-mapping/{pathv1}?{query} |
Yes |
| updateMediationProfileMapping(body, profileId, callback) |
Update a mediation profile mapping |
{base_path}/{version}/v4/template/mediation-profile-mapping/{pathv1}?{query} |
Yes |
| deleteMediationProfileMapping(profileId, callback) |
Delete an Mediation profile mapping |
{base_path}/{version}/v4/template/mediation-profile-mapping/{pathv1}?{query} |
Yes |
| getAllMediationProfileMappings(callback) |
Query all mediation profile mappings |
{base_path}/{version}/v4/template/mediation-profile-mappings?{query} |
Yes |
| getNfmpTemplate(callback) |
Query NFM-P system scripts. Some of these scripts may be used for service creation or modification. |
{base_path}/{version}/v4/template/nfmp-template?{query} |
Yes |
| getAllOchServices(callback) |
Query all OCH service creation templates |
{base_path}/{version}/v4/template/och-services?{query} |
Yes |
| createOchServices(body, callback) |
Create an OCH service creation template |
{base_path}/{version}/v4/template/och-services?{query} |
Yes |
| getOchServices(templateId, callback) |
Find an OCH service creation template by its unique identifier |
{base_path}/{version}/v4/template/och-services/{pathv1}?{query} |
Yes |
| updateOchServices(body, templateId, callback) |
Modify an OCH service creation template |
{base_path}/{version}/v4/template/och-services/{pathv1}?{query} |
Yes |
| deleteOchServices(templateId, callback) |
Delete an OCH service creation template |
{base_path}/{version}/v4/template/och-services/{pathv1}?{query} |
Yes |
| getAllOduServices(callback) |
Query all ODU service creation templates |
{base_path}/{version}/v4/template/odu-services?{query} |
Yes |
| createOduServices(body, callback) |
Create an ODU service creation template |
{base_path}/{version}/v4/template/odu-services?{query} |
Yes |
| getOduServices(templateId, callback) |
Find an ODU service creation template by its unique identifier |
{base_path}/{version}/v4/template/odu-services/{pathv1}?{query} |
Yes |
| updateOduServices(body, templateId, callback) |
Modify an ODU service creation template |
{base_path}/{version}/v4/template/odu-services/{pathv1}?{query} |
Yes |
| deleteOduServices(templateId, callback) |
Delete an ODU service creation template |
{base_path}/{version}/v4/template/odu-services/{pathv1}?{query} |
Yes |
| getAllOpticalConnectivityConstraint(callback) |
Query all optical connectivity constraint templates |
{base_path}/{version}/v4/template/optical-connectivity-constraint?{query} |
Yes |
| createOpticalConnectivityConstraint(body, callback) |
Create an optical connectivity constraint creation template |
{base_path}/{version}/v4/template/optical-connectivity-constraint?{query} |
Yes |
| getOpticalConnectivityConstraint(templateId, callback) |
Find an optical connectivity constraint creation template by its unique identifier |
{base_path}/{version}/v4/template/optical-connectivity-constraint/{pathv1}?{query} |
Yes |
| updateOpticalConnectivityConstraint(body, templateId, callback) |
Modify an optical connectivity constraint creation template |
{base_path}/{version}/v4/template/optical-connectivity-constraint/{pathv1}?{query} |
Yes |
| deleteOpticalConnectivityConstraint(templateId, callback) |
Delete an optical connectivity constraint creation template |
{base_path}/{version}/v4/template/optical-connectivity-constraint/{pathv1}?{query} |
Yes |
| getAllOpticalConnectivityService(callback) |
Query all optical connectivity service templates |
{base_path}/{version}/v4/template/optical-connectivity-service?{query} |
Yes |
| createOpticalConnectivityService(body, callback) |
Create an optical connectivity service creation template |
{base_path}/{version}/v4/template/optical-connectivity-service?{query} |
Yes |
| getOpticalConnectivityService(templateId, callback) |
Find an optical connectivity service creation template by its unique identifier |
{base_path}/{version}/v4/template/optical-connectivity-service/{pathv1}?{query} |
Yes |
| updateOpticalConnectivityService(body, templateId, callback) |
Modify an optical connectivity service creation template |
{base_path}/{version}/v4/template/optical-connectivity-service/{pathv1}?{query} |
Yes |
| deleteOpticalConnectivityService(templateId, callback) |
Delete an optical connectivity service creation template |
{base_path}/{version}/v4/template/optical-connectivity-service/{pathv1}?{query} |
Yes |
| getAllOpticalResilienceConstraint(callback) |
Query all optical resilience constraint templates |
{base_path}/{version}/v4/template/optical-resilience-constraint?{query} |
Yes |
| createOpticalResilienceConstraint(body, callback) |
Create an optical resilience constraint creation template |
{base_path}/{version}/v4/template/optical-resilience-constraint?{query} |
Yes |
| getOpticalResilienceConstraint(templateId, callback) |
Find an optical resilience constraint creation template by its unique identifier |
{base_path}/{version}/v4/template/optical-resilience-constraint/{pathv1}?{query} |
Yes |
| updateOpticalResilienceConstraint(body, templateId, callback) |
Modify an optical resilience constraint creation template |
{base_path}/{version}/v4/template/optical-resilience-constraint/{pathv1}?{query} |
Yes |
| deleteOpticalResilienceConstraint(templateId, callback) |
Delete an optical resilience constraint creation template |
{base_path}/{version}/v4/template/optical-resilience-constraint/{pathv1}?{query} |
Yes |
| getAllOpticalRoutingConstraint(callback) |
Query all optical routing constraint templates |
{base_path}/{version}/v4/template/optical-routing-constraint?{query} |
Yes |
| createOpticalRoutingConstraint(body, callback) |
Create an optical routing constraint creation template |
{base_path}/{version}/v4/template/optical-routing-constraint?{query} |
Yes |
| getOpticalRoutingConstraint(templateId, callback) |
Find an optical routing constraint creation template by its unique identifier |
{base_path}/{version}/v4/template/optical-routing-constraint/{pathv1}?{query} |
Yes |
| updateOpticalRoutingConstraint(body, templateId, callback) |
Modify an optical routing constraint creation template |
{base_path}/{version}/v4/template/optical-routing-constraint/{pathv1}?{query} |
Yes |
| deleteOpticalRoutingConstraint(templateId, callback) |
Delete an optical routing constraint creation template |
{base_path}/{version}/v4/template/optical-routing-constraint/{pathv1}?{query} |
Yes |
| getAllPathProfiles(callback) |
Query all path profile templates |
{base_path}/{version}/v4/template/path-profiles?{query} |
Yes |
| createPathProfiles(body, callback) |
Create a path profile template |
{base_path}/{version}/v4/template/path-profiles?{query} |
Yes |
| getPathProfiles(templateId, callback) |
Find a path profile template by its unique identifier |
{base_path}/{version}/v4/template/path-profiles/{pathv1}?{query} |
Yes |
| updatePathProfiles(body, templateId, callback) |
Update a path profile template |
{base_path}/{version}/v4/template/path-profiles/{pathv1}?{query} |
Yes |
| deletePathProfiles(templateId, callback) |
Delete an existing path profile template |
{base_path}/{version}/v4/template/path-profiles/{pathv1}?{query} |
Yes |
| getAllQos(callback) |
Query all QoS templates |
{base_path}/{version}/v4/template/qos?{query} |
Yes |
| createQos(body, callback) |
Create a QoS template |
{base_path}/{version}/v4/template/qos?{query} |
Yes |
| getAllQosPolicies(callback) |
Query all QoS policies |
{base_path}/{version}/v4/template/qos-policies?{query} |
Yes |
| getQosPolicies(neId, callback) |
Query all QoS policies of the provided network element |
{base_path}/{version}/v4/template/qos-policies/{pathv1}?{query} |
Yes |
| getQos(templateId, callback) |
Find a QoS template by its unique identifier |
{base_path}/{version}/v4/template/qos/{pathv1}?{query} |
Yes |
| updateQos(body, templateId, callback) |
Modify a QoS template |
{base_path}/{version}/v4/template/qos/{pathv1}?{query} |
Yes |
| deleteQos(templateId, callback) |
Delete a QoS template |
{base_path}/{version}/v4/template/qos/{pathv1}?{query} |
Yes |
| getAllRouterIdSystemIdMappings(callback) |
Query all router ID system ID mapping policy |
{base_path}/{version}/v4/template/router-id-system-id-mapping?{query} |
Yes |
| createRouterIdSystemIdMapping(body, callback) |
Create a router ID system ID mapping policy |
{base_path}/{version}/v4/template/router-id-system-id-mapping?{query} |
Yes |
| getRouterIdSystemIdMapping(policyId, callback) |
Find a router-id-system-id-mapping by its unique identifier |
{base_path}/{version}/v4/template/router-id-system-id-mapping/{pathv1}?{query} |
Yes |
| updateRouterIdSystemIdMapping(policyId, body, callback) |
Modify a router-id-system-id-mapping policy |
{base_path}/{version}/v4/template/router-id-system-id-mapping/{pathv1}?{query} |
Yes |
| deleteRouterIdSystemIdMapping(policyId, callback) |
Delete a router-id-mapping policy |
{base_path}/{version}/v4/template/router-id-system-id-mapping/{pathv1}?{query} |
Yes |
| getAllSystemIpMplsConfig(callback) |
Query all system IP MPLS Configuration |
{base_path}/{version}/v4/template/system-ip-mpls-config?{query} |
Yes |
| updateSystemIpMplsConfig(body, templateId, callback) |
Update a system ip mpls configuration |
{base_path}/{version}/v4/template/system-ip-mpls-config/{pathv1}?{query} |
Yes |
| getAllTunnelCreations(callback) |
Query all tunnel creation templates. Deprecated: Use get-all-tunnel-selections instead. |
{base_path}/{version}/v4/template/tunnel-creations?{query} |
Yes |
| updateTunnelCreations(templateId, body, callback) |
Modify a tunnel creation template. Deprecated: update-tunnel-selections instead. |
{base_path}/{version}/v4/template/tunnel-creations/{pathv1}?{query} |
Yes |
| getAllWorkflowProfileMappings(callback) |
Query all workflow profiles |
{base_path}/{version}/v4/template/workflow-profile?{query} |
Yes |
| createWorkflowProfile(body, callback) |
Create a workflow profile mapping |
{base_path}/{version}/v4/template/workflow-profile?{query} |
Yes |
| getWorkflowProfile(profileId, callback) |
Find a workflow profile mapping by its unique identifier |
{base_path}/{version}/v4/template/workflow-profile/{pathv1}?{query} |
Yes |
| updateWorkflowProfile(profileId, body, callback) |
Update a workflow profile mapping |
{base_path}/{version}/v4/template/workflow-profile/{pathv1}?{query} |
Yes |
| deleteWorkflowProfile(profileId, callback) |
Delete a workflow profile |
{base_path}/{version}/v4/template/workflow-profile/{pathv1}?{query} |
Yes |
| getV4Tenants(callback) |
gets |
{base_path}/{version}/v4/tenants?{query} |
Yes |
| postV4Tenants(body, callback) |
create |
{base_path}/{version}/v4/tenants?{query} |
Yes |
| getCustomerAll(callback) |
Query all Customers |
{base_path}/{version}/v4/tenants/customer-all?{query} |
Yes |
| getCustomer(customerId, callback) |
Find a customer by customer-Id |
{base_path}/{version}/v4/tenants/customer/{pathv1}?{query} |
Yes |
| resync(provider = 'KEYSTONE', callback) |
resync |
{base_path}/{version}/v4/tenants/resync/{pathv1}?{query} |
Yes |
| getV4TenantsTenantUuid(tenantUuid, callback) |
get |
{base_path}/{version}/v4/tenants/{pathv1}?{query} |
Yes |
| putV4TenantsTenantUuid(body, tenantUuid, callback) |
update |
{base_path}/{version}/v4/tenants/{pathv1}?{query} |
Yes |
| deleteV4TenantsTenantUuid(tenantUuid, callback) |
delete |
{base_path}/{version}/v4/tenants/{pathv1}?{query} |
Yes |
| getResources(tenantUuid, callback) |
getResources |
{base_path}/{version}/v4/tenants/{pathv1}/resources?{query} |
Yes |
| addResources(body, tenantUuid, callback) |
addResources |
{base_path}/{version}/v4/tenants/{pathv1}/resources?{query} |
Yes |
| deleteResources(body, tenantUuid, callback) |
deleteResources |
{base_path}/{version}/v4/tenants/{pathv1}/resources?{query} |
Yes |
| getUsergroup(groupName, tenantUuid, callback) |
getUsergroup |
{base_path}/{version}/v4/tenants/{pathv1}/usergroup/{pathv2}?{query} |
Yes |
| deleteUsergroup(groupName, tenantUuid, callback) |
deleteUsergroup |
{base_path}/{version}/v4/tenants/{pathv1}/usergroup/{pathv2}?{query} |
Yes |
| createUsergroup(groupName, roleType = 'OPERATOR', tenantUuid, callback) |
createUsergroup |
{base_path}/{version}/v4/tenants/{pathv1}/usergroup/{pathv2}/role/{pathv3}?{query} |
Yes |
| getV4Usergroups(callback) |
Query all Usergroups |
{base_path}/{version}/v4/usergroups?{query} |
Yes |
| getV4UsergroupsGroupName(groupName, callback) |
Find a Usergroup by a group name |
{base_path}/{version}/v4/usergroups/{pathv1}?{query} |
Yes |
| getV4UsergroupsGroupNameTenants(groupName, callback) |
getTenants |
{base_path}/{version}/v4/usergroups/{pathv1}/tenants?{query} |
Yes |
| getNrcpHistorical(callback) |
getNrcpHistorical |
{base_path}/{version}/v4/nsp/configuration/nrcp-historical?{query} |
Yes |
| patchNrcpHistorical(body, callback) |
patchNrcpHistorical |
{base_path}/{version}/v4/nsp/configuration/nrcp-historical?{query} |
Yes |
| getSrPolicyConfig(callback) |
getSrPolicyConfig |
{base_path}/{version}/v4/nsp/configuration/sr-policy-config?{query} |
Yes |
| patchSrPolicyConfig(body, callback) |
patchSrPolicyConfig |
{base_path}/{version}/v4/nsp/configuration/sr-policy-config?{query} |
Yes |
| addElineEndpoint(serviceUuid, body, callback) |
addElineEndpoint |
{base_path}/{version}/v4/services/elines/{pathv1}/endpoint?{query} |
Yes |
| addL3DciL3Endpoint(serviceUuid, body, callback) |
addL3DciL3Endpoint |
{base_path}/{version}/v4/services/l3-dcis/{pathv1}/endpoint?{query} |
Yes |
| addL3DciL3LoopbackEndpoint(serviceUuid, body, callback) |
addL3DciL3LoopbackEndpoint |
{base_path}/{version}/v4/services/l3-dcis/{pathv1}/loopback-endpoint?{query} |
Yes |
| patchL3DciL3LoopbackEndpoint(endpointUuid, serviceUuid, body, callback) |
patchL3DciL3LoopbackEndpoint |
{base_path}/{version}/v4/services/l3-dcis/{pathv1}/loopback-endpoint/{pathv2}?{query} |
Yes |
| updateStitchL2Ext(l2extServiceUuid, serviceEndpointUuid, serviceUuid, callback) |
updateStitchL2Ext |
{base_path}/{version}/v4/services/stitch-l2-ext/{pathv1}/{pathv2}/{pathv3}?{query} |
Yes |
| deleteTopologyReferencesByDomain(networkId, callback) |
deleteTopologyReferencesByDomain |
{base_path}/{version}/v4/nsp/net/l3/topology-references/domain/{pathv1}?{query} |
Yes |
| deleteTopologyReferencesByLink(linkId, callback) |
deleteTopologyReferencesByLink |
{base_path}/{version}/v4/nsp/net/l3/topology-references/link/{pathv1}?{query} |
Yes |
| diagnoseLsp(lspPathId, callback) |
diagnoseLsp |
{base_path}/{version}/v4/nsp/pathtool/diagnose-lsp/{pathv1}?{query} |
Yes |
| diagnosePath(body, callback) |
diagnosePath |
{base_path}/{version}/v4/nsp/pathtool/diagnose-path?{query} |
Yes |
| addMultipointPort(multipointLinkId, portId, callback) |
addMultipointPort |
{base_path}/{version}/v4/physicallinks/multipoint-port/{pathv1}/{pathv2}?{query} |
Yes |
| removeMultipointPort(multipointLinkId, portId, callback) |
removeMultipointPort |
{base_path}/{version}/v4/physicallinks/multipoint-port/{pathv1}/{pathv2}?{query} |
Yes |
| deleteMultipoint(linkId, callback) |
deleteMultipoint |
{base_path}/{version}/v4/physicallinks/multipoint/{pathv1}?{query} |
Yes |
| createMultipoint(linkId, body, callback) |
createMultipoint |
{base_path}/{version}/v4/physicallinks/multipoint/{pathv1}?{query} |
Yes |
| getMultipoint(linkId, callback) |
getMultipoint |
{base_path}/{version}/v4/physicallinks/multipoint/{pathv1}?{query} |
Yes |
| getMultipoints(callback) |
getMultipoints |
{base_path}/{version}/v4/physicallinks/multipoints?{query} |
Yes |
| getAllConnectionProfile(neId, callback) |
getAllConnectionProfile |
{base_path}/{version}/v4/policy/all-connection-profile/{pathv1}?{query} |
Yes |
| createTriggerTtzAlgorithm(callback) |
createTriggerTtzAlgorithm |
{base_path}/{version}/v4/servicedebug/trigger-ttz-algorithm?{query} |
Yes |
| getSRPolicies(callback) |
getSRPolicies |
{base_path}/{version}/v4/srpolicies?{query} |
Yes |
| createSRPolicy(body, callback) |
createSRPolicy |
{base_path}/{version}/v4/srpolicies?{query} |
Yes |
| createCandidatePathResignal(id, callback) |
createCandidatePathResignal |
{base_path}/{version}/v4/srpolicies/candidate-path-resignal/{pathv1}?{query} |
Yes |
| patchCandidatePathAdmin(adminState = 'MAINTENANCE', candidatePathId, callback) |
patchCandidatePathAdmin |
{base_path}/{version}/v4/srpolicies/candidate-path/{pathv1}/admin/{pathv2}?{query} |
Yes |
| updateCandidatePaths(id, body, callback) |
updateCandidatePaths |
{base_path}/{version}/v4/srpolicies/candidate-paths/{pathv1}?{query} |
Yes |
| getSRPoliciesOnLink(linkId, requestType = 'MOVED', callback) |
getSRPoliciesOnLink |
{base_path}/{version}/v4/srpolicies/on-link/{pathv1}/{pathv2}?{query} |
Yes |
| deletePolicies(callback) |
deletePolicies |
{base_path}/{version}/v4/srpolicies/policies?{query} |
Yes |
| updatePolicies(id, body, callback) |
updatePolicies |
{base_path}/{version}/v4/srpolicies/policies/{pathv1}?{query} |
Yes |
| fetchPolicyList(body, callback) |
fetchPolicyList |
{base_path}/{version}/v4/srpolicies/policy-list?{query} |
Yes |
| deletePolicy(id, callback) |
deletePolicy |
{base_path}/{version}/v4/srpolicies/policy/{pathv1}?{query} |
Yes |
| patchPolicyAdmin(adminState = 'MAINTENANCE', srPolicyId, callback) |
patchPolicyAdmin |
{base_path}/{version}/v4/srpolicies/policy/{pathv1}/admin/{pathv2}?{query} |
Yes |
| createSRPoliciesResignal(body, callback) |
createSRPoliciesResignal |
{base_path}/{version}/v4/srpolicies/resignal?{query} |
Yes |
| findSdnPath(body, callback) |
findPath |
{base_path}/{version}/v4/nsp/pathtool/find-path?{query} |
Yes |
| getAssocGroupConfig(callback) |
getAssocGroupConfig |
{base_path}/{version}/v4/nsp/configuration/assoc-group-config?{query} |
Yes |
| patchAssocGroupConfig(body, callback) |
patchAssocGroupConfig |
{base_path}/{version}/v4/nsp/configuration/assoc-group-config?{query} |
Yes |
| getBsidGenerationConfig(callback) |
getBsidGenerationConfig |
{base_path}/{version}/v4/nsp/configuration/bsid-generation-config?{query} |
Yes |
| patchBsidGenerationConfig(body, callback) |
patchBsidGenerationConfig |
{base_path}/{version}/v4/nsp/configuration/bsid-generation-config?{query} |
Yes |
| getDeviceNameIpService(callback) |
getDeviceNameIpService |
{base_path}/{version}/v4/nsp/configuration/device-name-ip-service?{query} |
Yes |
| patchDeviceNameIpService(body, callback) |
patchDeviceNameIpService |
{base_path}/{version}/v4/nsp/configuration/device-name-ip-service?{query} |
Yes |
| getLspBsidGenerationConfig(callback) |
getLspBsidGenerationConfig |
{base_path}/{version}/v4/nsp/configuration/lsp-bsid-generation-config?{query} |
Yes |
| patchLspBsidGenerationConfig(body, callback) |
patchLspBsidGenerationConfig |
{base_path}/{version}/v4/nsp/configuration/lsp-bsid-generation-config?{query} |
Yes |
| getAssocGroups(callback) |
getAssocGroups |
{base_path}/{version}/v4/mpls/assoc-groups?{query} |
Yes |
| getAssocGroupsByType(associationGroupType, callback) |
getAssocGroupsByType |
{base_path}/{version}/v4/mpls/assoc-groups-by-type/{pathv1}?{query} |
Yes |
| lspPathProfileOverride(body, callback) |
lspPathProfileOverride |
{base_path}/{version}/v4/mpls/lsp-path-profile-override?{query} |
Yes |
| fetchLspPathsByTunnelId(body, callback) |
fetchLspPathsByTunnelId |
{base_path}/{version}/v4/mpls/lsp-paths-by-tunnel-id?{query} |
Yes |
| getOnAssocGroup(associationGroupId, associationGroupSource, associationGroupType, callback) |
getOnAssocGroup |
{base_path}/{version}/v4/mpls/lsp/paths/on-assoc-group/{pathv1}/{pathv2}/{pathv3}?{query} |
Yes |
| getOnBsid(bsidId, callback) |
getOnBsid |
{base_path}/{version}/v4/mpls/lsp/paths/on-bsid/{pathv1}?{query} |
Yes |
| getProfileGroup(extendedId, profileId, callback) |
getProfileGroup |
{base_path}/{version}/v4/mpls/lsp/paths/profile-group/{pathv1}/{pathv2}?{query} |
Yes |
| fetchLinks(body, callback) |
fetchLinks |
{base_path}/{version}/v4/nsp/net/l3/links?{query} |
Yes |
| findPath(body, callback) |
findPath |
{base_path}/{version}/v4/nsp/pathtool/find-path?{query} |
Yes |
| getByKey(color, endpoint, headend, callback) |
getByKey |
{base_path}/{version}/v4/srpolicies/by-key/{pathv1}/{pathv2}/{pathv3}?{query} |
Yes |
| fetchCandidatePathList(body, callback) |
fetchCandidatePathList |
{base_path}/{version}/v4/srpolicies/candidate-path-list?{query} |
Yes |
| getConsumer(id, callback) |
getConsumer |
{base_path}/{version}/v4/srpolicies/consumer/{pathv1}?{query} |
Yes |
| createResignalAll(callback) |
createResignalAll |
{base_path}/{version}/v4/srpolicies/resignal-all?{query} |
Yes |
| createResignalSRPolicies(body, callback) |
createResignal |
{base_path}/{version}/v4/srpolicies/resignal?{query} |
Yes |
| getSRPolicyByID(id, callback) |
gets |
{base_path}/{version}/v4/srpolicies/{pathv1}?{query} |
Yes |