Tags - Tag Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/tag/{Name}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: tag
Tag objects define strings that can be used to annotate other objects, particularly Event objects.
FieldDescription
collectormgrsA list of references to Collector Managers that will add this tag to events reported by each Collector controlled by the managers.
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
descA short description of the tag's purpose and origin.
event-sourcesA list of references to Event Sources that will add this tag to events reported by each Event Source.
event-source-serversA list of references to Event Source Servers that will add this tag to events reported by each Event Source reporting to the servers.
global-filtersA list of references to Routing Rules that will add this tag to events routed by each rule.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
moddateThe date and time when the object was last modified.
modifierThe URL of the Sentinel User object that represents the last modifier of the object.
nameThe string value that is the tag used to annotate other objects.
pluginsA list of references to Collector plugins that will add this tag to events reported by each Collector.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/tag/PCI
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"tag",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/tag/PCI"
   },
   "moddate":"2012-04-25T13:33:44.600Z",
   "desc":"A tag for data related to the Payment Card Industry's Data Security Standard (PCI DSS).",
   "name":"PCI",
   "createdate":"2012-04-25T13:33:44.600Z",
   "event-source-servers":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "global-filters":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/global-filter/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "plugins":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/plugin/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "collectormgrs":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/collectormgr/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "event-sources":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource/79600390-9B73-102E-A3E2-001676E4A757"
   ]
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: tag
Tag objects define strings that can be used to annotate other objects, particularly Event objects.
FieldRequiredDescription
collectormgrsfalseA list of references to Collector Managers that will add this tag to events reported by each Collector controlled by the managers.
descfalseA short description of the tag's purpose and origin.
event-sourcesfalseA list of references to Event Sources that will add this tag to events reported by each Event Source.
event-source-serversfalseA list of references to Event Source Servers that will add this tag to events reported by each Event Source reporting to the servers.
global-filtersfalseA list of references to Routing Rules that will add this tag to events routed by each rule.
nametrueThe string value that is the tag used to annotate other objects.
pluginsfalseA list of references to Collector plugins that will add this tag to events reported by each Collector.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/tag/PCI
{
   "desc":"A tag for data related to the Payment Card Industry's Data Security Standard (PCI DSS).",
   "name":"PCI",
   "event-source-servers":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "global-filters":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/global-filter/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "plugins":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/plugin/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "collectormgrs":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/collectormgr/79600390-9B73-102E-A3E2-001676E4A757"
   ],
   "event-sources":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource/79600390-9B73-102E-A3E2-001676E4A757"
   ]
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/tag/PCI