--- title: "Legacy Orchestrator Northbound REST APIs" slug: "legacy-orchestrator-northbound-rest-apis" status: "new" updated: 2026-03-04T19:55:41Z published: 2026-03-04T20:30:55Z canonical: "docs.crossworkassurance.cisco.com/legacy-orchestrator-northbound-rest-apis" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.crossworkassurance.cisco.com/llms.txt > Use this file to discover all available pages before exploring further. # Northbound REST API ## Introduction Welcome to the Legacy Orchestrator Northbound REST API documentation. The API allows you to operate the Legacy Orchestrator in a simple, programmatic way using conventional HTTP requests. The goal of the API is to be intuitive and powerful, allowing you to easily create, manage, delete and operate key Legacy Orchestrator resources. Most of the functionality that you are familiar with in the Legacy Orchestrator CLI is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation starts with a general overview about the design and technology that has been implemented, followed by reference information about specific resources. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. | **Method** | **Usage** | | --- | --- | | GET | For simple retrieval of information about a resource you should use the GET method. The information you request will be returned to you as an XML object. | | DELETE | To delete a resource, use the DELETE method. | | PUT | To update a resource, use the PUT method. | | PATCH | To update a part of resource, use the PATCH method. | | POST | To create a new object, your request should specify the POST method. | ## HTTP Status Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. Status in the 500 range, generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently. ## Responses When a request is successful, a response body will typically be sent back in the form of an XML object. ## Errors When a request fail, additional error information will be supplied in the response body in the form of an XML object. Possible errors: | **Code** | **Text** | | --- | --- | | 4101 | Failed to connect to MGR server daemon. | | 4105 | MGR has no active Case. | | 4106 | Internal MGR Error. | | 4107 | Client Error. | | 4108 | Server Error | | 5100 | Discovered. Existing in keyfile | | 5101 | Discovered. Not existing in keyfile | | 5102 | Not discovered. Not existing in keyfile | | 5103 | Not discovered. Exist in keyfile | **Sample:** ``` ``` ## Authentication The API uses basic authentication, so we recommend accessing the REST services over HTTPS. ## Resource and Method Summary | Resource | Method | Description | | --- | --- | --- | | https://servername/nbapi/configuration/messagebrokerconfig | GET / POST | - | | https://servername/nbapi/configuration/messagebrokerconfig/{id} | PUT / DELETE / GET | - | | https://servername/nbapi/endpoint | GET | Get header information (EndpointHead) for all endpoints. | | https://servername/nbapi/endpoint/{name}/reflectorConfig | GET / PUT | Retrieves all reflector configurations from the device. / Update the status and port of multiple reflector configuration. | | https://servername/nbapi/endpoint/{name} | DELETE | Delete an endpoint. | | https://servername/nbapi/endpoint/{name}/description | PUT | Change endpoint description. | | https://servername/nbapi/endpoint/{name}/endpointhead | GET | Get header information (EndpointHead) for a specified headpoint. | | https://servername/nbapi/endpoint/{name}/name | PUT | Change name of endpoint. | | https://servername/nbapi/endpoint/{name}/operate | PUT | Operation on endpoint. | | https://servername/nbapi/endpoint/type/{type} | GET | Get information (EndpointHead) on all endpoints of given type. | | https://servername/nbapi/endpoint/reflector | POST | Create a new unmanaged reflector. | | https://servername/nbapi/endpoint/reflector/{mac}/mac | GET | Get unmanaged reflector parameters by mac address. | | https://servername/nbapi/endpoint/reflector/{name} | GET | Get unmanaged reflector parameters by name. | | https://servername/nbapi/endpoint/reflector/{name}/address | PUT | Change ip address of unmanaged reflector that was terminated or is unresolved. | | https://servername/nbapi/endpoint/reflector/{name}/capability | PUT | Change capability of unmanaged reflector. | | https://servername/nbapi/endpoint/reflector/{name}/twampcp | PUT / DELETE | Change TWAMP control protocol settings of unmanaged reflector. / Delete TWAMP control protocol settings. | | https://servername/nbapi/endpoint/supervision | POST | Create a new supervision endpoint. | | https://servername/nbapi/endpoint/supervision/{name} | GET | Get supervision endpoint parameters by name. | | https://servername/nbapi/session | GET | Get header information (SessionHead) for all sessions. | | https://servername/nbapi/session/generic/{name_or_id} | GET / PATCH / PUT | Get session resource. / Update a session with a part of resource. / Update a session with the entire resource. | | https://servername/nbapi/session/{name} | DELETE | Delete a session with terminate option. | | https://servername/nbapi/session/{name}/description | PUT | Change session description. | | https://servername/nbapi/session/{name}/head | GET | Get header information (SessionHead) for a session specified by name. | | https://servername/nbapi/session/{name}/name | PUT | Change the name of a terminated or unresolved session. | | https://servername/nbapi/session/{name}/operate | PUT | Perform an operation (action) on a session. | | https://servername/nbapi/session/{name}/stream | PUT | Change the attributes of a terminated or unresolved session stream. | | https://servername/nbapi/session/echo | POST | Create a new Echo session. | | https://servername/nbapi/session/echo/{name} | GET | Get information about an Echo session. | | https://servername/nbapi/session/ethoam | POST | Create a new ETH-OAM session. | | https://servername/nbapi/session/ethoam/{name} | GET | Get information about an ETH-OAM session. | | https://servername/nbapi/session/twamp | POST | Create a new TWAMP session. | | https://servername/nbapi/session/twamp/{name} | GET | Get information about a TWAMP session. | | https://servername/nbapi/sla | GET | Get all SLAs (export groups). | | https://servername/nbapi/sla/{name}/session | GET | Get all session references for a specified SLA. | | https://servername/nbapi/systemid | GET | Get system id. | | https://servername/nbapi/version | GET | Get the version of the Manager. | ## Resources ### https://servername/nbapi/configuration/messagebrokerconfig #### Methods | GET | | | --- | --- | Get all the message broker configs **request** Not applicable **responses** *status:* 200 - OK *representations* | application/json | | | --- | --- | | POST | | | --- | --- | Create a message broker config **request** *representations* | */ * | | | --- | --- | **responses** *status:* 200 - OK *representations* | application/json | | | --- | --- | ### https://servername/nbapi/configuration/messagebrokerconfig/{id} #### Methods | PUT | | | --- | --- | Update a message broker config **request** *template params* | id | [long](http://www.w3.org/TR/xmlschema-2/#long) | | --- | --- | *representations* | */ * | | | --- | --- | **responses** *status:* 200 - OK *representations* | application/json | | | --- | --- | | DELETE | | | --- | --- | Delete a message broker config **request** template params | id | [long](http://www.w3.org/TR/xmlschema-2/#long) | | --- | --- | **responses** *status:* 200 - OK *representations* | */ * | | | --- | --- | | GET | | | --- | --- | Get a message broker config by its {id} **request** *template params* | id | [long](http://www.w3.org/TR/xmlschema-2/#long) | | --- | --- | **responses** *status:* 200 - OK *representations* | application/json | | | --- | --- | ### https://servername/nbapi/endpoint The endpoint resource provides the api for handling endpoints. #### Methods | GET | | | --- | --- | Get header information (EndpointHead) for all endpoints. **request** Not applicable **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | EndpointHead | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EndpointHead ip="10.1.1.1" mac="00:15:ad:17:86:20" name="SampleActuator" product="P2770" serialNo="sn-00-001122" state="UNKNOWN" type="Supervision"/>` | | --- | --- | --- | ### https://servername/nbapi/endpoint/{name}/reflectorConfig #### Methods | GET | | | --- | --- | Retrieves all reflector configurations from the device. Also, can filter configurations by peer type or protocol. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *query params* | peerType | [string](http://www.w3.org/TR/xmlschema-2/#string) | peer type | | --- | --- | --- | | protocol | [string](http://www.w3.org/TR/xmlschema-2/#string) | protocol | **responses** *status:* 400 *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 *representations* | application/xml application/json | | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ReflectorConfiguration peerType="2way-rf" port="4000" protocol="udp-ipv4" state="1"/>` | | --- | --- | --- | | PUT | | | --- | --- | Update the status and port of multiple reflector configuration. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | ReflectorConfiguration | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ReflectorConfiguration peerType="2way-rf" port="4000" protocol="udp-ipv4" state="1"/>` | | --- | --- | --- | | application/json | ReflectorConfiguration | | **responses** *status:* 400 *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 *representations* | application/xml application/json | | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ReflectorConfiguration peerType="2way-rf" port="4000" protocol="udp-ipv4" state="1"/>` | | --- | --- | --- | ### https://servername/nbapi/endpoint/{name} #### Methods | DELETE | | | --- | --- | Delete an endpoint. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/text | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/{name}/description #### Methods | PUT | | | --- | --- | Change endpoint description. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | Description | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Description description="description"/>` | | --- | --- | --- | | application/json | Description | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/{name}/endpointhead #### Methods | GET | | | --- | --- | Get header information (EndpointHead) for a specified headpoint. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | EndpointHead | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EndpointHead ip="10.1.1.1" mac="00:15:ad:17:86:20" name="SampleActuator" product="P2770" serialNo="sn-00-001122" state="UNKNOWN" type="Supervision"/>` | | --- | --- | --- | ### https://servername/nbapi/endpoint/{name}/name #### Methods | PUT | | | --- | --- | Change name of endpoint. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | Name | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Name name="newName"/>` | | --- | --- | --- | | application/json | Name | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/{name}/operate #### Methods | PUT | | | --- | --- | Operation on endpoint. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | Action | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Action action="resolve / terminate"/>` | | --- | --- | --- | | application/json | Action | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/type/{type} #### Methods | GET | | | --- | --- | Get information (EndpointHead) on all endpoints of given type. Supported types are: Supervision, Reflector, or All. **request** *template params* | type | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint type: Supervision, Reflector, All | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | EndpointHead | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EndpointHead ip="10.1.1.1" mac="00:15:ad:17:86:20" name="SampleActuator" product="P2770" serialNo="sn-00-001122" state="UNKNOWN" type="Supervision"/>` | | --- | --- | --- | ### https://servername/nbapi/endpoint/reflector The endpoint reflector resource provides the api for handling endpoint reflector. #### Methods | POST | | | --- | --- | Create a new unmanaged reflector. **request** *representations* | application/xml | Endpoint | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Endpoint description="description" ip="10.4.4.1" name="REFLNAME" product="Host" type="Reflector"> <Capabilities> <capability cap="echo-icmp-rf"/> <capability cap="echo-udp-rf"/> <capability cap="twamp-rf"/> </Capabilities> </Endpoint>` | | --- | --- | --- | | application/json | Endpoint | | **responses** *status:* 500 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 201 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Successfully created endpoint | | --- | --- | --- | ### https://servername/nbapi/endpoint/reflector/{mac}/mac #### Methods | GET | | | --- | --- | Get unmanaged reflector parameters by mac address. **request** *template params* | mac | [string](http://www.w3.org/TR/xmlschema-2/#string) | mac address | | --- | --- | --- | **responses** *status:* 500 - unmanaged reflector *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - unmanaged reflector *representations* | application/xml application/json | Endpoint | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Endpoint description="description" mac="00:15:ad:17:86:21" name="REFLNAME" product="Host" type="Reflector"> <Capabilities> <capability cap="ethdm-rf"/> <capability cap="ethlb-rf"/> <capability cap="ethvs-rf"/> </Capabilities> </Endpoint>` | | --- | --- | --- | ### https://servername/nbapi/endpoint/reflector/{name} #### Methods | GET | | | --- | --- | Get unmanaged reflector parameters by name. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | **responses** *status:* 500 - unmanaged reflector *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - unmanaged reflector *representations* | application/xml application/json | Endpoint | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Endpoint description="description" ip="10.4.4.1" name="REFLNAME" product="Host" type="Reflector"> <Capabilities> <capability cap="echo-icmp-rf"/> <capability cap="echo-udp-rf"/> <capability cap="twamp-rf"/> </Capabilities> </Endpoint>` | | --- | --- | --- | ### https://servername/nbapi/endpoint/reflector/{name}/address #### Methods | PUT | | | --- | --- | Change ip address of unmanaged reflector that was terminated or is unresolved. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | IpAddress | | --- | --- | | application/json | IpAddress | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/reflector/{name}/capability #### Methods | PUT | | | --- | --- | Change capability of unmanaged reflector. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | Capabilities | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Capabilities> <capability cap="ethdm-rf"/> <capability cap="ethlb-rf"/> <capability cap="ethvs-rf"/> <capability cap="echo-icmp-rf"/> <capability cap="echo-udp-rf"/> <capability cap="twamp-rf"/> </Capabilities>` | | --- | --- | --- | | application/json | Capabilities | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/reflector/{name}/twampcp #### Methods | PUT | | | --- | --- | Change TWAMP control protocol settings of unmanaged reflector. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | *representations* | application/xml | TwampCp | | --- | --- | | application/json | TwampCp | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | | DELETE | | | --- | --- | Delete TWAMP control protocol settings. **request** template params | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/endpoint/supervision The endpoint supervision resource provides the api for handling endpoint supervision. #### Methods | POST | | | --- | --- | Create a new supervision endpoint. **request** *representations* | application/xml | Endpoint | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Endpoint description="Description" ip="10.4.4.1" mac="00:11:11:11:1F" name="VCXNAME" port="22" product="VCX-VNID" serialNo="sn-00-001122" state="Connected" type="Supervision"/>` | | --- | --- | --- | | application/json | Endpoint | | **responses** *status:* 500 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 201 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Successfully created endpoint | | --- | --- | --- | ### https://servername/nbapi/endpoint/supervision/{name} #### Methods | GET | | | --- | --- | Get supervision endpoint parameters by name. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | endpoint name | | --- | --- | --- | **responses** *status:* 500 - Endpoint *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - Endpoint *representations* | application/xml application/json | Endpoint | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Endpoint description="Description" ip="10.4.4.1" mac="00:11:11:11:1F" name="VCXNAME" port="22" product="VCX-VNID" serialNo="sn-00-001122" state="Connected" type="Supervision"/>` | | --- | --- | --- | ### https://servername/nbapi/session The session resource provides the api for handling session. #### Methods | GET | | | --- | --- | Get header information (SessionHead) for all sessions. **request** Not applicable **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | SessionHead | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SessionHead name="sessionName" receiverNodeName="rcvReflector" senderNodeName="sndActuator" sessionType="TWAMP" sid="sid"/>` | | --- | --- | --- | ### https://servername/nbapi/session/generic/{name_or_id} #### Methods | GET | | | --- | --- | Get session resource. **request** *template params* | name_or_id | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name or session id | | --- | --- | --- | *query params* | idAsName | [boolean](http://www.w3.org/TR/xmlschema-2/#boolean) | This is to mark if session name is an integer number. By default, a number will be parsed to session id | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | Session | | --- | --- | | PATCH | | | --- | --- | Update a session with a part of resource. **request** *template params* | name_or_id | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name or session id | | --- | --- | --- | *query params* | idAsName | [boolean](http://www.w3.org/TR/xmlschema-2/#boolean) | This is to mark if session name is an integer number. By default, a number will be parsed to session id | | --- | --- | --- | *representations* | */ * | Session | | --- | --- | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | | PUT | | | --- | --- | Update a session with the entire resource. **request** *template params* | name_or_id | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name or session id | | --- | --- | --- | *query params* | idAsName | [boolean](http://www.w3.org/TR/xmlschema-2/#boolean) | This is to mark if session name is an integer number. By default, a number will be parsed to session id | | --- | --- | --- | *representations* | */ * | Session | | --- | --- | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/session/{name} #### Methods | DELETE | | | --- | --- | Delete a session with terminate option. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | *query params* | terminate | [boolean](http://www.w3.org/TR/xmlschema-2/#boolean) | allow to terminate session before deleting or not | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/text | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/session/{name}/description #### Methods | PUT | | | --- | --- | Change session description. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | *representations* | application/xml | Description | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Description description="description"/>` | | --- | --- | --- | | application/json | Description | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/session/{name}/head #### Methods | GET | | | --- | --- | Get header information (SessionHead) for a session specified by name. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | **responses** *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | SessionHead | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SessionHead name="sessionName" receiverNodeName="rcvReflector" senderNodeName="sndActuator" sessionType="TWAMP" sid="sid"/>` | | --- | --- | --- | ### https://servername/nbapi/session/{name}/lastrr #### Methods | GET | | | --- | --- | Get last Result Record (RR) for a specified session. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | **responses** *status:* 500 - RR *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - RR *representations* | application/xml application/json | RR | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <RR date="2018-01-01 01:02:03 UTC" direction="p2r" dp50="50" dpmax="60" dpmin="40" errcode="0" lossPercent="1.0"/>` | | --- | --- | --- | ### https://servername/nbapi/session/{name}/name #### Methods | PUT | | | --- | --- | Change the name of a terminated or unresolved session. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | *representations* | application/xml | String | Example: newName | | --- | --- | --- | | application/json | String | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | *status:* 412 - response *representations* | application/xml application/json | | precondition failed | | --- | --- | --- | ### https://servername/nbapi/session/{name}/operate #### Methods | PUT | | | --- | --- | Perform an operation (action) on a session. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | *query params* | sync | [boolean](http://www.w3.org/TR/xmlschema-2/#boolean) | mark whether this is a synchronous request or not | | --- | --- | --- | *representations* | application/xml | Action | Example: ` ` | | --- | --- | --- | --- | --- | | application/json | Action | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested does is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | ### https://servername/nbapi/session/{name}/stream #### Methods | PUT | | | --- | --- | Change the attributes of a terminated or unresolved session stream. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | *representations* | application/xml | Stream | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Stream payloadsize="16" pps="100.0" type="UDP"/>` | | --- | --- | --- | | application/json | Stream | | **responses** *status:* 400 - response *representations* | application/xml application/json | | Bad Request - action requested is not supported | | --- | --- | --- | *status:* 500 - response *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - response *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - response *representations* | application/xml application/json | | Operation performed OK | | --- | --- | --- | *status:* 412 - response *representations* | application/xml application/json | | precondition failed | | --- | --- | --- | ### https://servername/nbapi/session/echo The session echo resource provides the api for handling session echo. #### Methods | POST | | | --- | --- | Create a new Echo session. **request** *representations* | application/xml | EchoSession | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EchoSession addressFamily="ipv4" dstEndpoint="rcvReflector" dstIfc="ext0" dstPort="4000" interval="30" name="sessionEx" srcEndpoint="sndActuator" srcIfc="e1" srcPort="4000" state="UNKNOWN" tos="0" ttl="1" vprio="0"> <Stream payloadsize="82" pps="10.0" type="UDP"/> </EchoSession>` | | --- | --- | --- | | application/json | EchoSession | | **responses** *status:* 500 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 201 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | EchoSession | Successfully created echo session | | --- | --- | --- | ### https://servername/nbapi/session/echo/{name} #### Methods | GET | | | --- | --- | Get information about an Echo session. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | **responses** *status:* 500 - a EchoSession object *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - a EchoSession object *representations* | application/xml application/json | | Example: explanation why this service is not available | | --- | --- | --- | *status:* 200 - a EchoSession object *representations* | application/xml application/json | EchoSession | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EchoSession addressFamily="ipv4" dstEndpoint="rcvReflector" dstIfc="ext0" dstPort="4000" interval="30" name="sessionEx" srcEndpoint="sndActuator" srcIfc="e1" srcPort="4000" state="UNKNOWN" tos="0" ttl="1" vprio="0"> <Stream payloadsize="82" pps="10.0" type="UDP"/> </EchoSession>` | | --- | --- | --- | ### https://servername/nbapi/session/ethoam The session ethoam resource provides the api for handling session ethoam. #### Methods | POST | | | --- | --- | Create a new ETH-OAM session. Supported types are ETH-DM, ETH-LB, and ETH-VS. **request** *representations* | application/xml | EthOamSession | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EthOamSession description="description" dstEndpoint="rcvReflector" dstIfc="ext0" interval="30" megLevel="0" name="sessionEx" reflectorTimeSubtraction="enable" roundTripDelay="disable" srcEndpoint="sndActuator" srcIfc="e1" state="UNKNOWN" vprio="0"> <Stream payloadsize="82" pps="10.0" type="ETH-DM"/> </EthOamSession>` | | --- | --- | --- | | application/json | EthOamSession | | **responses** *status:* 500 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 201 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | EthOamSession | Successfully created eth-oam session | | --- | --- | --- | ### https://servername/nbapi/session/ethoam/{name} #### Methods | GET | | | --- | --- | Get information about an ETH-OAM session. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | **responses** *status:* 500 - a EthOamSession object *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - a EthOamSession object *representations* | application/xml application/json | EthOamSession | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <EthOamSession description="description" dstEndpoint="rcvReflector" dstIfc="ext0" interval="30" megLevel="0" name="sessionEx" reflectorTimeSubtraction="enable" roundTripDelay="disable" srcEndpoint="sndActuator" srcIfc="e1" state="UNKNOWN" vprio="0"> <Stream payloadsize="82" pps="10.0" type="ETH-DM"/> </EthOamSession>` | | --- | --- | --- | ### https://servername/nbapi/session/twamp The session twamp resource provides the api for handling session twamp. #### Methods | POST | | | --- | --- | Create a new TWAMP session. **request** *representations* | application/xml | [TwampSession | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TwampSession addressFamily="ipv4" dstEndpoint="rcvReflector" dstIfc="ext0" dstPort="4000" interval="30" name="sessionEx" reflectorTimeSubtraction="enable" roundTripDelay="disable" srcEndpoint="sndActuator" srcIfc="e1" srcPort="4000" state="UNKNOWN" tos="0" ttl="1" vprio="0"> <Stream payloadsize="82" pps="10.0" type="UDP"/> </TwampSession>` | | --- | --- | --- | | application/json | TwampSession | | **responses** *status:* 500 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 201 - response *headers* | Location | uri | The URI where the created item is accessible. | | --- | --- | --- | *representations* | application/xml application/json | TwampSession | Successfully created twamp session | | --- | --- | --- | ### https://servername/nbapi/session/twamp/{name} #### Methods | GET | | | --- | --- | Get information about a TWAMP session. **request** *template params* | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | session name | | --- | --- | --- | **responses** *status:* 500 - a TwampSession object *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - a TwampSession object *representations* | application/xml application/json | | Example: explanation why this service is not available | | --- | --- | --- | *status:* 200 - a TwampSession object *representations* | application/xml application/json | TwampSession | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <TwampSession addressFamily="ipv4" dstEndpoint="rcvReflector" dstIfc="ext0" dstPort="4000" interval="30" name="sessionEx" reflectorTimeSubtraction="enable" roundTripDelay="disable" srcEndpoint="sndActuator" srcIfc="e1" srcPort="4000" state="UNKNOWN" tos="0" ttl="1" vprio="0"> <Stream payloadsize="82" pps="10.0" type="UDP"/> </TwampSession>` | | --- | --- | --- | ### https://servername/nbapi/sla The sla resource provides the api for handling SLA. #### Methods | GET | | | --- | --- | Get all SLAs (export groups). **request** Not applicable **responses** *status:* 500 - a collection of Sla objects *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - a collection of Sla objects *representations* | application/text | Sla | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Sla name="Example: Sla"> <description>example desc</description> </Sla>` | | --- | --- | --- | ### https://servername/nbapi/sla/{name}/session #### Methods | GET | | | --- | --- | Get all session references for a specified SLA. **request** template params | name | [string](http://www.w3.org/TR/xmlschema-2/#string) | sla name | | --- | --- | --- | **responses** *status:* 500 - a collection of SessionRef objects *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 404 - a collection of SessionRef objects *representations* | application/xml application/json | | Not Found | | --- | --- | --- | *status:* 200 - a collection of SessionRef objects *representations* | application/text | [SessionRef] | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <SessionRef name="SessionId"/>` | | --- | --- | --- | ### https://servername/nbapi/systemid The system id resource provides the api for handling system id. #### Methods | GET | | | --- | --- | Get system id. **request** Not applicable **responses** *status:* 500 - systemId *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - systemId *representations* | application/xml application/json | SystemId | | --- | --- | ### https://servername/nbapi/version The version resource provides the api for handling version. #### Methods | GET | | | --- | --- | Get the version of the Manager. **request** Not applicable **responses** *status:* 500 - version *representations* | application/xml application/json | | Bad request or internal error. Check body for error message. | | --- | --- | --- | *status:* 200 - version *representations* | application/xml application/json | Version | Example: `<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Version version="MAIN"/>` | | --- | --- | --- | --- **© 2026 Cisco and/or its affiliates. All rights reserved.** For more information about trademarks, please visit: [Cisco trademarks](https://www.cisco.com/c/en/us/about/legal/trademarks.html)[](https://www.cisco.com/c/en/us/about/legal/trademarks.html) For more information about legal terms, please visit: [Cisco legal terms](https://www.cisco.com/c/en/us/about/legal/terms-conditions.html)