Skip to main content
Matrix42 Self-Service Help Center

Rest API – Edge Devices

How to query Edge Devices using the FireScope REST API. Edge Device creation and deletion by API is not supported.


The REST API allows you to retrieve Edge Devices in FireScope SPM.

  • Retrieve
  • Search
  • Create or Update
  • Delete


To retrieve the current information about an Edge Device as a JSON document, send a GET request with the following URL format:


Note: Don’t forget to change the domain name (localhost) and query parameter values (account, and name) to match your environment and data.

 Query Parameter Descriptions

Parameter Description Type Required
account Name of account. String Yes
name Name of the Edge Device String Yes


Searching provides for the ability to return multiple results in a single call using various filter criteria. To accomplish this, a GET request is sent with a parameter search=true. Every other field besides account is optional and is used to further filter the results. Pagination is mandatory and accomplished using the page and size parameters. The JSON response will wrap the result list and also display the page and the size. The size in the response represents the number of results actually returned, not the size in the request. The response does not contain a count of the total number of pages or the total number of records for performance reasons. The client is expected to keep querying, increasing the page each time, until the result size is less than the requested size, indicating no more results.


Note: Don’t forget to change the domain name (localhost) and query parameter values (account, name, page and size) to match your environment and data.

Search Parameter Descriptions

Parameter Description Type Default Required
account Name of the SPM Account. String   Yes
search Enable searching by setting to true. Setting to false will revert functionality to retrieving a single result. Boolean FALSE Yes
page Indicates which result set is being returned starting at zero and increasing until there are no more results Number 0 Yes
size Indicates how many results are returned in a single page. A max of 250 results is supported. Number 100 Yes
name Filter the results by a case-insensitive substring search of the name field.

Example Search Response

   "account_id": "firescope",
   "entity": "edge_device",
   "page": 0,
   "size": 1,
   "results": [{      "account_id" : "firescope",      "description" : "Dallas Datacenter",      "global_properties" : {         "cloud_ip" : "",         "edge_services_http_ports" : "18050,18051",         "edge_services_https_ports" : "18060,18061",         "edge_services_jmx_ports" : "18040,18041",         "ui_services_http_ports" : "28050,28051",         "ui_services_https_ports" : "28060,28061",         "ui_services_jmx_ports" : "28040,28041"      },      "ip" : "",      "name" : "Dallas",      "protocol" : "http",      "status" : 1,      "timezone" : "America/Chicago"   }]

Property Descriptions

Property Description Type Default Value Required
account_id Name of the SPM Account. String   Yes
description A description of the Edge device. String   Yes
ip The IP address where the Edge Device resides String   Yes
name Name of the SPM Edge Device String   Yes
global_properties List of properties that the Edge Device uses.
PropertyDescriptionTypeDefault ValueRequiredcloud_ip String Noedge_services_https_ports String Noedge_services_http_ports String Noedge_services_jmx_ports String Noui_services_https_ports String Noui_services_http_ports String Noui_services_jmx_ports String No
Object   No
protocol The protocol the Edge Device uses to communicate with the SPM application server. Only http and https currently supported. String   Yes
status Indicates whether the Edge Device is enabled or not.0 = Disabled1 = Enabled Number 1 Yes
timezone The configured timezone that the Edge Device is running in. String    

Create or Update

Creating and updating an Edge Device is not supported.


Deletion of an Edge Device is not supported.

  • Was this article helpful?