Back to main API page

Data Collectors - EventSource List and Create Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource

Supported Methods

GET
POST
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

Required

None.

Optional

ParameterTypeDefault ValueDescription
query string [no filter] The TinyQ language filter that specifies a subset of all available records.
field string not present The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values,
page integer 1 The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize.
pagesize integer [unlimited] The maximum number of object records to return as a result of the request.

Success Codes

Fault Codes

Response Data

Object type: page
A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing.
FieldDescription
nextA URL addressing the subsequent page of objects in the total set of available objects.
objectsThe list of objects returned in the page of results.
prevA URL addressing the previous page of objects in the total set of available objects.
Object type: eventsource
Needs description.
FieldDescription
configNeeds description. Definition
connectorNeeds description.
createdateThe date and time when the object was created.
creatorThe URL of the Sentinel User object that represents the creator of the object.
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.
tagsNeeds 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: evt-src-config
Needs description.
FieldDescription
alert-no-dataNeeds description.
conn-modeNeeds description.
data-rate-limitNeeds description.
no-data-thresholdNeeds description.
propertiesNeeds description. Definition
raw-data-fileNeeds description.
save-raw-dataNeeds description.
send-repeated-alertsNeeds description.
SoftOffNeeds description.
trusted-timeNeeds description.

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource?page=2&pagesize=1
Sample Response for application/json
Status: 200
{
   "objects":[
      {
         "meta":{
            "type":"eventsource",
            "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource/79600390-9B73-102E-A3E2-001676E4A757"
         },
         "moddate":"2012-04-25T13:33:44.689Z",
         "name":"Wildebeest",
         "createdate":"2012-04-25T13:33:44.689Z",
         "config":{
            "save-raw-data":true,
            "alert-no-data":true,
            "data-rate-limit":42,
            "raw-data-file":"Wildebeest",
            "conn-mode":"Wildebeest",
            "no-data-threshold":42,
            "send-repeated-alerts":true,
            "SoftOff":true,
            "trusted-time":true,
            "properties":[
               {
                  "hidden":true,
                  "name":"Wildebeest",
                  "value":"Wildebeest",
                  "type":"Wildebeest",
                  "custom":true
               }
            ]
         },
         "on":true,
         "tags":[
            "PCI"
         ]
      }
   ],
   "prev":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource?pagesize=1&page=1"
   },
   "next":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource?pagesize=1&page=3"
   }
}
POST

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

Response

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: eventsource
Needs description.
FieldRequiredDescription
configfalseNeeds description. Definition
connectorfalseNeeds description.
nametrueNeeds description.
ontrueNeeds description.
tagsfalseNeeds 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: evt-src-config
Needs description.
FieldRequiredDescription
alert-no-datafalseNeeds description.
conn-modefalseNeeds description.
data-rate-limitfalseNeeds description.
no-data-thresholdfalseNeeds description.
propertiesfalseNeeds description. Definition
raw-data-filefalseNeeds description.
save-raw-datafalseNeeds description.
send-repeated-alertsfalseNeeds description.
SoftOfffalseNeeds description.
trusted-timefalseNeeds description.

Response Data

Object type:
The metadata representation of the newly-created eventsource object, including the URL reference to the new object.
FieldDescription
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
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: evt-src-config
Needs description.
FieldDescription
alert-no-dataNeeds description.
conn-modeNeeds description.
data-rate-limitNeeds description.
no-data-thresholdNeeds description.
propertiesNeeds description. Definition
raw-data-fileNeeds description.
save-raw-dataNeeds description.
send-repeated-alertsNeeds description.
SoftOffNeeds description.
trusted-timeNeeds description.

Sample Request

POST https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource
{
   "name":"Wildebeest",
   "config":{
      "save-raw-data":true,
      "alert-no-data":true,
      "data-rate-limit":42,
      "raw-data-file":"Wildebeest",
      "conn-mode":"Wildebeest",
      "no-data-threshold":42,
      "send-repeated-alerts":true,
      "SoftOff":true,
      "trusted-time":true,
      "properties":[
         {
            "hidden":true,
            "name":"Wildebeest",
            "value":"Wildebeest",
            "type":"Wildebeest",
            "custom":true
         }
      ]
   },
   "on":true,
   "tags":[
      "PCI"
   ]
}
Sample Response for application/json
Status: 201
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource/79600390-9B73-102E-A3E2-001676E4A757
{
   "meta":{
      "type":"eventsource",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/eventsource/79600390-9B73-102E-A3E2-001676E4A757"
   }
}
Back to main API page