Rest API - IP Groups
Overview
The REST API allows you to work with IP Groups using a REST Client in lieu of the FireScope user interface. Below you'll find documentation for the following operations:
- Direct Fetch
- Schema
- Search
- Create or Update
- Delete
Direct Fetch
To retrieve the current data for an IP Group as a JSON document, send a GET request with the following URL format:
https://localhost:38060/web_services/ip_group?account=yourAccount&edge_device=yourEdgeName&name=yourIpGroupName
Be sure to change the domain name (localhost
) and query parameters (account
, edge_device
, name
) values to match your environment and data.
Query Parameter Descriptions
Property | Description | Type | Required |
---|---|---|---|
account | Name of the FireScope Account. | String | Yes |
edge_device | Name of the IP Group's Edge Device. | String | Yes |
name | Name of the IP Group. | String | Yes |
Schema
To retrieve the full schema of an IP Group object, with all available fields, their data types, enumeration values, and read/write permissions send a GET request with the following URL format:
https://localhost:38060/web_services/ip_group?account=yourAccount&schema=true
Be sure to change the domain name (localhost
) and query parameter (account
) value to match your environment and data.
Schema Parameter Descriptions
Property | Description | Type | Required |
---|---|---|---|
account | Name of the FireScope Account. | String | Yes |
schema | If true , the response will contain the full schema of the object with all available fields, their data types, potential enumeration values, and read/write permissions. |
Boolean | Yes |
Search
Search is not supported for this REST API endpoint at this time.
Create or Update
To create or update an IP Group, send a POST request with a JSON document containing the specific IP Group information to the following URL:
https://localhost:38060/web_services/ip_group
Be sure to change the domain name (localhost
) to match your environment and data.
{ "account_id": "SDDM", "edge_device_id": "DallasCOLOEdge1", "ip": [ "192.168.5.0-255", "192.168.6.0-255" ], "hostname": [ "esx16.imagoverum.com", "esx17.imagoverum.com" ], "name": "192.168.5-6.X IP Group" }
Property Descriptions
The following table provides information about all the required and optional properties available for an IP Group.
The following table only includes fields that can be modified through the API. It does not include descriptions of all available fields in an object. See the Schema API call for a list of all possible fields available and their data types.
Property | Description | Type | Default | Required |
---|---|---|---|---|
account_id | Name of the FireScope Account. | String | Yes | |
edge_device_id | Name of the Edge Device to associate with the IP Group. | String | Yes | |
name | A unique name for this IP Group on this Edge Device | String | Yes | |
hostname | An array of host names to consider as members of this IP Group. | String[] | [] | No |
ip | An array of IP addresses, IPs with Octet Ranges, or CIDRs to consider as members of this IP Group. Examples:
|
String[] | [] | No |
Delete
To delete an IP Group, send a DELETE request using the same query parameters as the Direct Fetch request.