Version 7.2
113
Mediant 500 MSBR
User's Manual
12. REST-Based Management
12
REST-Based Management
You can manage the device through the Representational State Transfer (REST)
architecture. REST is a Web-based access service, allowing you to access the device's
management interface over HTTP/S. Developers can use the device's REST API to
integrate the device into their solution and allow administrators to perform management
and configuration tasks through automation scripts.
The REST API relies on a simple pre-defined URL path (
< device's OAMP IP address
>/api/v1
) through which device resources can be accessed. Each resource represents a
specific device management element (e.g., file upload), state object (e.g., alarms), or
maintenance action (e.g., reset). The REST API uses the standard HTTP/1.1 protocol.
Standard HTTP methods (GET, PUT, POST and DELETE) are used to read the resource’s
state and to create, update, and delete the resources, respectively. Resource state is
described in JSON format and included in the HTTP request or response bodies. For
security, it is recommended to secure REST traffic by using HTTPS.
The figure below displays an example of accessing the device’s active alarms through
REST, using a standard Web browser. To facilitate your understanding of REST, the
example shows each navigation step to the active alarms resource; however, you would
typically access the active alarms resource directly using its full URL path (i.e.,
/api/v1/alarms/active
).
Figure
12-1: Accessing Device's REST Interface via Web
Figure
12-2: REST Resource - Alarms
Summary of Contents for Mediant 500 MSBR
Page 2: ......
Page 33: ...Part I Getting Started with Initial Connectivity ...
Page 34: ......
Page 36: ...User s Manual 36 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 40: ...User s Manual 40 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 45: ...Part II Management Tools ...
Page 46: ......
Page 48: ...User s Manual 48 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 115: ...Part III General System Settings ...
Page 116: ......
Page 132: ...User s Manual 132 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 137: ...Part IV General VoIP Configuration ...
Page 138: ......
Page 290: ...User s Manual 290 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 306: ...User s Manual 306 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 380: ...User s Manual 380 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 454: ...User s Manual 454 Document LTRT 10375 Mediant 500 MSBR This page is intentionallty left blank ...
Page 455: ...Part V Gateway Application ...
Page 456: ......
Page 460: ...User s Manual 460 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 484: ...User s Manual 484 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 494: ...User s Manual 494 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 625: ...Part VI Session Border Controller Application ...
Page 626: ......
Page 654: ...User s Manual 654 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 656: ...User s Manual 656 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 741: ...Part VII Cloud Resilience Package ...
Page 742: ......
Page 751: ...Part VIII Data Router Configuration ...
Page 752: ......
Page 753: ......
Page 754: ......
Page 756: ...User s Manual 756 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 757: ...Part IX Maintenance ...
Page 758: ......
Page 834: ...User s Manual 834 Document LTRT 10375 Mediant 500 MSBR This page is intetnionaly left blank ...
Page 837: ...Part X Status Performance Monitoring and Reporting ...
Page 838: ......
Page 848: ...User s Manual 848 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 852: ...User s Manual 852 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 854: ...User s Manual 854 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 878: ...User s Manual 878 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 880: ...User s Manual 880 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 926: ...User s Manual 926 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 927: ...Part XI Diagnostics ...
Page 928: ......
Page 950: ...User s Manual 950 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 954: ...User s Manual 954 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 956: ...User s Manual 956 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 958: ...User s Manual 958 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 974: ...User s Manual 974 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 976: ...User s Manual 976 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...
Page 977: ...Part XII Appendix ...
Page 978: ......
Page 982: ...User s Manual 982 Document LTRT 10375 Mediant 500 MSBR This page is intentionally left blank ...