Skip to main content

root

Creates, updates, deletes, gets or lists a root resource.

Overview

Nameroot
TypeResource
Idsumologic.parsers.root

Fields

The following fields are returned by SELECT queries:

Root folder in the library.

NameDatatypeDescription
idstringIdentifier of the folder or parser.
namestringName of the folder or parser.
parent_idstringIdentifier of the parent folder. (wire: parentId)
childrenarrayChildren of the folder.
content_typestringType of the content. Valid values: 1) Folder 2) Parser (wire: contentType)
created_atstring (date-time)Creation timestamp in UTC in [RFC3339](https:​//tools.ietf.org/html/rfc3339) format. (wire: createdAt)
created_bystringIdentifier of the user who created the resource. (wire: createdBy)
descriptionstringDescription of the folder or parser.
is_lockedbooleanWhether the object is locked. (wire: isLocked)
is_mutablebooleanImmutable objects are "READ-ONLY". (wire: isMutable)
is_systembooleanSystem objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated. (wire: isSystem)
modified_atstring (date-time)Last modification timestamp in UTC. (wire: modifiedAt)
modified_bystringIdentifier of the user who last modified the resource. (wire: modifiedBy)
typestringType of the object model.
versioninteger (int64)Version of the folder or parser.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectregionGet the root folder in the library.<br />

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.

NameDatatypeDescription
regionstringSumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)

SELECT examples

Get the root folder in the library.<br />

SELECT
id,
name,
parent_id,
children,
content_type,
created_at,
created_by,
description,
is_locked,
is_mutable,
is_system,
modified_at,
modified_by,
type,
version
FROM sumologic.parsers.root
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;