System Information - Sentinel Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/sentinel-system/{Id}

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: sentinel-system
Needs description.
FieldDescription
collector-mgrsNeeds description.
configNeeds description. Definition
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
hostsNeeds description.
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.
nameNeeds description.
onNeeds description.
onlineNeeds description.
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
Object type: sentinel-config
Needs description.
FieldDescription
alert-no-dataNeeds description.
data-rate-limitNeeds description.
no-data-thresholdNeeds description.
propertiesNeeds description. Definition
raw-data-fileNeeds description.
save-raw-dataNeeds description.
send-repeated-alertsNeeds description.
trusted-timeNeeds description.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/sentinel-system/79600390-9B73-102E-A3E2-001676E4A757
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"sentinel-system",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/sentinel-system/79600390-9B73-102E-A3E2-001676E4A757"
   },
   "moddate":"2012-04-25T13:33:44.614Z",
   "name":"Wildebeest",
   "createdate":"2012-04-25T13:33:44.614Z",
   "config":{
      "save-raw-data":true,
      "alert-no-data":true,
      "data-rate-limit":42,
      "raw-data-file":"Wildebeest",
      "no-data-threshold":42,
      "send-repeated-alerts":true,
      "trusted-time":true,
      "properties":[
         {
            "hidden":true,
            "name":"Wildebeest",
            "value":"Wildebeest",
            "type":"Wildebeest",
            "custom":true
         }
      ]
   },
   "on":true,
   "online":true,
   "collector-mgrs":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/collectormgr?query=SentinelId.e79600390-9B73-102E-A3E2-001676E4A757"
   },
   "hosts":[
      "https://164.99.19.131:8443/SentinelRESTServices/objects/host/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: sentinel-system
Needs description.
FieldRequiredDescription
collector-mgrsfalseNeeds description.
configfalseNeeds description. Definition
nametrueNeeds description.
ontrueNeeds description.
onlinetrueNeeds description.

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

Object type: sentinel-config
Needs description.
FieldRequiredDescription
alert-no-datafalseNeeds description.
data-rate-limitfalseNeeds description.
no-data-thresholdfalseNeeds description.
propertiesfalseNeeds description. Definition
raw-data-filefalseNeeds description.
save-raw-datafalseNeeds description.
send-repeated-alertsfalseNeeds description.
trusted-timefalseNeeds description.

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/sentinel-system/79600390-9B73-102E-A3E2-001676E4A757
{
   "name":"Wildebeest",
   "config":{
      "save-raw-data":true,
      "alert-no-data":true,
      "data-rate-limit":42,
      "raw-data-file":"Wildebeest",
      "no-data-threshold":42,
      "send-repeated-alerts":true,
      "trusted-time":true,
      "properties":[
         {
            "hidden":true,
            "name":"Wildebeest",
            "value":"Wildebeest",
            "type":"Wildebeest",
            "custom":true
         }
      ]
   },
   "on":true,
   "online":true,
   "collector-mgrs":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/collectormgr?query=SentinelId.e79600390-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/sentinel-system/79600390-9B73-102E-A3E2-001676E4A757