Skip to main content
Matrix42 Self-Service Help Center

Rest API- Using the Firefox RESTClient Plugin

Installing and using the Firefox RESTClient Plugin is one way to write utilities for the REST API.

Overview

If you are new to REST or not skilled in writing utilities around Web Services, you can experiment with FireScope SPM API interfaces. Installing and using the Firefox RESTClient Plugin is one way to write utilities for the REST API. 

Before You Begin

Before you begin using the Firefox RESTClient Plugin, make sure you have: 

  • The Firefox RESTClient Plugin
  • A working SPM instance and Account
  • An Admin level User in the SPM Account
  • At least 1 Edge Device defined for the SPM Account
  • A sample JSON payload
clipboard_e36a68bd6a46c9092751a3debed0863f8.png
 
clipboard_eaa02bfbcacf30c42b5e9d487e9c8307c.png

Configuring the RESTClient Once you have installed RESTClient in Firefox, you must configure the authentication as required for REST calls. To configure the RESTClient:# At the top of your web browser, click the RESTClient icon   . The RESTClient tool page will be displayed.Note:  If you do not see the RESTClient icon, you can click Tools > RESTClient instead. 

  1. Click Authentication > Basic Authentication. The Basic Authorization window will be displayed.
clipboard_e2998a31b76511f55c058f22f4e0e2eb5.png
  1. Enter the Username and Password for your SPM Admin account.
  2. Click on Okay.
  3. Click on Headers > Custom Header. The Request Header window will be displayed.
clipboard_eae4b968aca3ff847884f9a78d9619661.png
  1. Enter the Name and Value.
  2. Click on the Okay button.
  3. Configure the Request for the operation you want to use.

Note:* To create or update an element in SPM, use the POST method to the target Web Service URL. To delete, use the DELETE method against the associated URL.

  • To view the Response from the Web Service, click View > Response. The Response section will be displayed below the Request section.
  • Was this article helpful?