Parameter | Type | Default Value | Description |
---|---|---|---|
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. |
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. | |
Field | Description |
next | A URL addressing the subsequent page of objects in the total set of available objects. |
objects | The list of objects returned in the page of results. |
prev | A URL addressing the previous page of objects in the total set of available objects. |
Object type: event-source-server | |
---|---|
Needs description. | |
Field | Description |
collectormgr | Needs description. |
config | Needs description. Definition |
connectors | Needs description. |
createdate | The date and time when the object was created. |
creator | The URL of the Sentinel User object that represents the creator of the object. |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
moddate | The date and time when the object was last modified. |
modifier | The URL of the Sentinel User object that represents the last modifier of the object. |
Name | Needs description. |
On | Needs description. |
plugin | Needs description. |
tags | Needs description. |
Object type: meta | |
---|---|
The metadata for an object, including the object type name and the URL reference to the object. | |
Field | Description |
@href | The URL reference to the object. |
type | The name of the object type |
Object type: evt-src-srv-config | |
---|---|
Needs description. | |
Field | Description |
alert-no-data | Needs description. |
ConnectionModeName | Needs description. |
data-rate-limit | Needs description. |
no-data-threshold | Needs description. |
properties | Needs description. Definition |
raw-data-file | Needs description. |
save-raw-data | Needs description. |
send-repeated-alerts | Needs description. |
trusted-time | Needs description. |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server?page=2&pagesize=1
{ "objects":[ { "meta":{ "type":"event-source-server", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server/79600390-9B73-102E-A3E2-001676E4A757" }, "Name":"Wildebeest", "moddate":"2012-04-25T13:33:44.697Z", "On":true, "createdate":"2012-04-25T13:33:44.697Z", "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, "ConnectionModeName":"Wildebeest", "properties":[ { "hidden":true, "name":"Wildebeest", "value":"Wildebeest", "type":"Wildebeest", "custom":true } ] }, "tags":[ "PCI" ], "connectors":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/connector?query=EventSourceServerId.e79600390-9B73-102E-A3E2-001676E4A757" } } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server?pagesize=1&page=3" } }
Object type: event-source-server | ||
---|---|---|
Needs description. | ||
Field | Required | Description |
collectormgr | false | Needs description. |
config | false | Needs description. Definition |
connectors | false | Needs description. |
Name | true | Needs description. |
On | true | Needs description. |
plugin | false | Needs description. |
tags | false | Needs description. |
Object type: meta | ||
---|---|---|
The metadata for an object, including the object type name and the URL reference to the object. | ||
Field | Required | Description |
@href | false | The URL reference to the object. |
type | false | The name of the object type |
Object type: evt-src-srv-config | ||
---|---|---|
Needs description. | ||
Field | Required | Description |
alert-no-data | false | Needs description. |
ConnectionModeName | false | Needs description. |
data-rate-limit | false | Needs description. |
no-data-threshold | false | Needs description. |
properties | false | Needs description. Definition |
raw-data-file | false | Needs description. |
save-raw-data | false | Needs description. |
send-repeated-alerts | false | Needs description. |
trusted-time | false | Needs description. |
Object type: | |
---|---|
The metadata representation of the newly-created event-source-server object, including the URL reference to the new object. | |
Field | Description |
meta | The 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. | |
Field | Description |
@href | The URL reference to the object. |
type | The name of the object type |
Object type: evt-src-srv-config | |
---|---|
Needs description. | |
Field | Description |
alert-no-data | Needs description. |
ConnectionModeName | Needs description. |
data-rate-limit | Needs description. |
no-data-threshold | Needs description. |
properties | Needs description. Definition |
raw-data-file | Needs description. |
save-raw-data | Needs description. |
send-repeated-alerts | Needs description. |
trusted-time | Needs description. |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server
{ "Name":"Wildebeest", "On":true, "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, "ConnectionModeName":"Wildebeest", "properties":[ { "hidden":true, "name":"Wildebeest", "value":"Wildebeest", "type":"Wildebeest", "custom":true } ] }, "tags":[ "PCI" ], "connectors":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/connector?query=EventSourceServerId.e79600390-9B73-102E-A3E2-001676E4A757" } }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server/79600390-9B73-102E-A3E2-001676E4A757
{ "meta":{ "type":"event-source-server", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/event-source-server/79600390-9B73-102E-A3E2-001676E4A757" } }