Rest API – Tags

+ More

Table of Contents

Overview Retrieve Example: Query Parameter Descriptions Create or Update Property Descriptions Delete

How to create, update, retrieve and delete tags in SPM using the Fire Scope REST API.

Overview

The REST API allows you to work with Tags in Fire Scope SPM using a REST client in lieu of the SPM user interface. Specifically, you can:

Retrieve
Create or Update
Delete

Retrieve

To retrieve the current information about a Tag, send unique query parameters in a GET request to the following URL:

http://[SPM IP address]:38050/web_services/tags?account=[Account name]&name=[Tag name]

Example:

http://localhost:38050/web_services/...pe&name=Server

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

A JSON response will be returned similar in structure to the payload for create.

Query Parameter Descriptions

Parameter	Description	Type	Required
account	Name of the SPM Account.	String	Yes
name	Name of the SPM Tag.	String	Yes

Create or Update

To create or update a Tag, POST a JSON document with the specific information for that Tag to the following URL:

http://[SPM IP address]:38050/web_services/tags

{
  "account_id" : "firescope",
  "name" : "Servers"
}

Property Descriptions

Property	Description	Type	Default Value	Required
account_id	Name of the SPM Account.	String		Yes
name	Name of the SPM Tag.	String		Yes

Delete

To delete a tag, send an HTTP DELETE request with the same query parameters as the GET request.

See the Retrieve for the URL format and query parameter descriptions.