root
Creates, updates, deletes, gets or lists a root
resource.
Overview
Name | root |
Type | Resource |
Id | sumologic.monitors.root |
Fields
The following fields are returned by SELECT
queries:
- getMonitorsLibraryRoot
Root folder of the monitors library.
Name | Datatype | Description |
---|---|---|
id | string | Identifier of the monitor or folder. |
name | string | Identifier of the monitor or folder. |
children | array | Children of the folder. NOTE: Permissions field will not be filled (empty list) for children. |
contentType | string | Type of the content. Valid values: 1) Monitor 2) Folder |
createdAt | string (date-time) | Creation timestamp in UTC in RFC3339 format. |
createdBy | string | Identifier of the user who created the resource. |
description | string | Description of the monitor or folder. |
isMutable | boolean | Immutable objects are "READ-ONLY". |
isSystem | boolean | System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. |
modifiedAt | string (date-time) | Last modification timestamp in UTC. |
modifiedBy | string | Identifier of the user who last modified the resource. |
parentId | string | Identifier of the parent folder. |
permissions | array | Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint. |
type | string | Type of the object model. |
version | integer (int64) | Version of the monitor or folder. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
getMonitorsLibraryRoot | select | region | Get the root folder in the monitors library. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
SELECT
examples
- getMonitorsLibraryRoot
Get the root folder in the monitors library.
SELECT
id,
name,
children,
contentType,
createdAt,
createdBy,
description,
isMutable,
isSystem,
modifiedAt,
modifiedBy,
parentId,
permissions,
type,
version
FROM sumologic.monitors.root
WHERE region = '{{ region }}' -- required
;