Skip to main content

path

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

Overview

Namepath
TypeResource
Idsumologic.monitors.path

Fields

The following fields are returned by SELECT queries:

Full path of the monitor or folder.

NameDatatypeDescription
pathstringString representation of the path.
pathItemsarrayElements of the path.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getMonitorsFullPathselectid, regionGet the full path of the monitor or folder in the monitors library.
monitorsGetByPathexecpath, regionRead a monitor or folder by its path in the monitors library structure.

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
idstringIdentifier of the monitor or folder.
pathstringThe path of the monitor or folder.
regionstringSumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)

SELECT examples

Get the full path of the monitor or folder in the monitors library.

SELECT
path,
pathItems
FROM sumologic.monitors.path
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

Lifecycle Methods

Read a monitor or folder by its path in the monitors library structure.

EXEC sumologic.monitors.path.monitorsGetByPath 
@path='{{ path }}' --required,
@region='{{ region }}' --required
;