REST Resources

/api/space/managed-domain/managed-elements/{id}/ptps/{ptpId}

The following operation is supported on this resource:

  • GET - Get PTP information for the managed element
GET /managed-elements/{id}/ptps/{ptpId}Version 1

This API returns physical termination point (PTP) information for a single point.

Sample Usage

GET /managed-elements/{id}/ptps/{ptpId}


  • Parameters:
    NameTypeURI TypeDescriptionRequired
    me-idintPathThe ID of the managed element from which to retreive the PTP information. Y
    ptp-idintPathThe ID of the PTP for which information is needed. Y
  • Sample Output XML:

    <ptp href="/api/space/managed-domain/ptps/262144"
            uri= "/api/space/managed-domain/managed-elements/262148/ptps/262144">
       <id>262144</id>
       <name>lo0</name>
       <deviceId>229377</deviceId>
       <loopback>true</loopback>
       <encapsulation>none</encapsulation>
       <tagging>NONE</tagging>
       <adminStatus>up</adminStatus>
       <operationStatus>up</operationStatus>
       <linkLevelType>Ethernet</linkLevelType>
       <linkType>full-duplex</linkType>
       <speed>0</speed>
       <mtu>0</mtu>
       <mtuStr>Unlimited</mtuStr>
       <managed-element href="/api/space/managed-domain/managed-elements/262148">
          <id>262148</id>
          <ipAddr>192.168.21.9</ipAddr>
       </managed-element>
    </ptp>

  • Sample Output JSON:

    {
      "ptp":{
        "@href":"/api/space/managed-domain/ptps/262144",
        "@uri": "/api/space/managed-domain/managed-elements/262148/ptps/262144",
        "id":262144,
        "name":"lo0",
        "deviceId":229377,
        "loopback":true,
        "encapsulation":"none",
        "tagging":"NONE"
        "adminStatus":"up",
        "operationStatus":"up",
        "linkLevelType":"Ethernet",
        "linkType":"full-duplex",
        "speed":0,
        "mtu":0,
        "mtuStr":"Unlimited",
        "managed-element":{
            "@href": "/api/space/managed-domain/managed-elements/262148",
            "id":262148,
            "ipAddr":"192.168.21.9"
        }
      }
    }

    • Access Control

    The following capabilities are required to access this API: ViewInterfaces