RESTful API

SageVue integrates Representational State Transfer (REST) Application Programming Interface (API), or what's better known as RESTful API. This technology allows end-users to automate the use of SageVue to match the custom needs of an organization. Use of this documentation assumes an end-user is comfortable using APIs, can use programming tools such as curl, and are competent writing code using programming language libraries such as .NET HttpClient library.

All APIs except the following listed below require an http request header that includes the SessionId paired with the GUID value that is returned to the client as the LoginId value upon successful authentication. The SessionId identifies the individual user of the service

APIs that do not require a SessionId (Authentication token):

• GET /api/IsAlive
• POST /api/Activation
• POST /api/Login
• POST /api/Login/LoginMfa
• POST /api/Login/SendMfaCode
• POST /api/Mfa/MfaFormats/User
• POST /api/Mfa/MfaVerification/User

All APIs return status code 200 when successfully executed.

SageVue API Documentation

API documentation for SageVue may be accessed from the following webpage:

http://api.sagevue-help.biamp.com/