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: menu-item | |
---|---|
Object representing a configured event action. | |
Field | Description |
action | The ID of the action to execute. |
command | The system command to execute. |
description | The description of the event action. |
enabled | Flag indicating if action is enabled(1) or disabled(0). |
file-type | The type of content generated by executing the action; such as txt, html or xml. |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
name | The name or title of the event action. |
parameters | Parameters to pass to the action or command. |
permission | Reserved for future use. |
use-browser | Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false). |
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 |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item?page=2&pagesize=1
{ "objects":[ { "meta":{ "type":"menu-item", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item/Wildebeest/Ping%20Target%20IP" }, "enabled":"Wildebeest", "use-browser":"false", "description":"Ping the target IP address of the selected event.", "name":"Ping Target IP", "command":"nslookup", "action":"Wildebeest", "permission":"Wildebeest", "parameters":"?queryinput=%TargetIP%", "file-type":"txt" } ], "prev":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item?pagesize=1&page=1" }, "next":{ "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item?pagesize=1&page=3" } }
Object type: menu-item | ||
---|---|---|
Object representing a configured event action. | ||
Field | Required | Description |
action | false | The ID of the action to execute. |
command | false | The system command to execute. |
description | false | The description of the event action. |
enabled | false | Flag indicating if action is enabled(1) or disabled(0). |
file-type | false | The type of content generated by executing the action; such as txt, html or xml. |
name | false | The name or title of the event action. |
parameters | false | Parameters to pass to the action or command. |
permission | false | Reserved for future use. |
use-browser | false | Flag indicating if the results of the action should be displayed in a Web browser(true) or the action display window(false). |
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: | |
---|---|
The metadata representation of the newly-created menu-item 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 |
POST https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item
{ "enabled":"Wildebeest", "use-browser":"false", "description":"Ping the target IP address of the selected event.", "name":"Ping Target IP", "command":"nslookup", "action":"Wildebeest", "permission":"Wildebeest", "parameters":"?queryinput=%TargetIP%", "file-type":"txt" }
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item/Wildebeest/Wildebeest
{ "meta":{ "type":"menu-item", "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/menu-item/Wildebeest/Wildebeest" } }