Interact with MSP Manager's public API

MSP Manager uses Swagger as a way to document all API endpoints with the opportunity to test the update prior to changing any data.

There are a few terms you should be familiar with when interacting with the MSP Manager API:

  • CUD - abbreviation for Create Update Delete
  • PUT - overwrites and updates existing item
  • POST - creates new item

The MSP Manager API is a live interface with your account's actual data. Please use extreme caution when using the API, particularly with PUT, POST and DELETE calls.

Authorize MSP Manager's Swaggar API

Navigate to MSP Manager's Public API to get started and enter your authorization credentials.

  1. Make sure /odata is selected from the Servers list and click Authorize to open the Available authorizations window.
  1. In the Basic section of the window, enter your MSP Manager username and password and click Authorize.

After the credentials are accepted and the authorization is successful, click Close to navigate to the Swagger API.

How to use MSP Manager's API

All time and date formatting within the Swagger interface is in UTC format.

  1. Click any web request to expand and view its details, along with any required parameters. Not all requests have associated parameters, if none are listed then the request does not require any.
  2. Click Try it out.
  3. Enter any parameters, if required, and click Execute.
  4. Swagger shows the response, and whether the request was successful, along with additional details.
  5. The Response window is separated into multiple parts:
    1. CURL: used from the command line or code to get the same response you see in Swagger.
    2. Request URL used to access the MSP Manager API
    3. Response Code. See the Response Header section (e) for an explanation of the code.
    4. Response headers: The header results of the request.
    5. Explanation of response codes and an example of what successful results will look like.