v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
monitorsLibraryManagement

Update a monitor or folder.

Update a monitor or folder in the monitors library. When making updates to existing monitors via API, all configurations are over-written. Make sure to include all configurations of the monitor (existing with new updates), not just the new configurations you want to apply.

put/v1/monitors/{id}

Path parameters

idstring required

Identifier of the monitor or folder to update.

Request body

namestring required

The name of the monitor or folder.

descriptionstring

The description of the monitor or folder.

versioninteger required

The version of the monitor or folder.

typestring required

Type of the object model.

Response

The monitor or folder was updated.

idstring required

Identifier of the monitor or folder.

namestring required

Identifier of the monitor or folder.

descriptionstring required

Description of the monitor or folder.

versioninteger required

Version of the monitor or folder.

createdAtstring date-time required

Creation timestamp in UTC in RFC3339 format.

createdBystring required

Identifier of the user who created the resource.

modifiedAtstring date-time required

Last modification timestamp in UTC.

modifiedBystring required

Identifier of the user who last modified the resource.

parentIdstring required

Identifier of the parent folder.

contentTypestring required

Type of the content. Valid values:

  1. Monitor
  2. Folder
typestring required

Type of the object model.

isSystemboolean required

System objects are objects provided by Sumo Logic. System objects can only be localized. Non-local fields can't be updated.

isMutableboolean required

Immutable objects are "READ-ONLY".

permissionsstring[]

Aggregated permission summary for the calling user. If detailed permission statements are required, please call list permissions endpoint.

Example response

{
  "permissions": [
    "Read",
    "Delete"
  ]
}