Monitor Management API. Monitors continuously query your data to monitor and send notifications when specific events occur. For more information see [Monitors](https://help.sumologic.com/?cid=10020).
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement monitorsLibraryManagement API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: monitorsLibraryManagement
description: 'Monitor Management API.
Monitors continuously query your data to monitor and send notifications when specific events occur.
For more information see [Monitors](https://help.sumologic.com/?cid=10020).
'
x-displayName: Monitors
paths:
/v1/monitors/usageInfo:
get:
tags:
- monitorsLibraryManagement
summary: Usage Info Of Monitors.
description: Get the current number and the allowed number of log and metrics monitors.
operationId: getMonitorUsageInfo
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: MonitorUsageInfo has been retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorUsageInfo'
/v1/monitors/disable:
put:
tags:
- monitorsLibraryManagement
summary: Disable Monitors.
description: Bulk disable monitors by the given identifiers.
operationId: disableMonitorByIds
parameters:
- name: ids
in: query
description: A comma-separated list of identifiers.
required: true
style: form
explode: false
schema:
type: array
items:
type: string
example: 0000000000000001,0000000000000002,0000000000000003
responses:
'200':
description: Disabled monitors
content:
application/json:
schema:
$ref: '#/components/schemas/DisableMonitorResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/playbooks:
get:
tags:
- monitorsLibraryManagement
summary: List All Playbooks.
description: List all playbooks available to run.
operationId: getMonitorPlaybooks
parameters:
- name: playbookType
in: query
description: A string value for playbook type.
required: false
schema:
type: string
example: CSE
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: MonitorPlaybooks have been retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorPlaybooksList'
/v1/monitors/playbooksDetails:
get:
tags:
- monitorsLibraryManagement
summary: Get Playbook Details.
description: Get the details of the playbooks with the specified identifiers.
operationId: getPlaybooksDetails
parameters:
- name: ids
in: query
description: A comma-separated list of playbook identifiers.
required: true
style: form
explode: false
schema:
type: array
items:
type: string
example: 649074b5b3d402d6e80b0d1d,649074b7b3d402d6e80b0da1,649074b6b3d402d6e80b0d75
responses:
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'200':
description: MonitorPlaybooks have been retrieved successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorPlaybooksList'
/v1/monitors:
get:
tags:
- monitorsLibraryManagement
summary: Bulk Read A Monitor Or Folder.
description: Bulk read a monitor or folder by the given identifiers from the monitors library.
operationId: monitorsReadByIds
parameters:
- name: ids
in: query
description: A comma-separated list of identifiers.
required: true
schema:
type: array
items:
type: string
example: 0000000000000001,0000000000000002,0000000000000003
- name: skipChildren
in: query
description: a boolean parameter to control skipping fetching children of requested folder(s)
required: false
schema:
type: boolean
responses:
'200':
description: A map between an identifier and its definition (monitor or folder).
content:
application/json:
schema:
$ref: '#/components/schemas/IdToMonitorsLibraryBaseResponseMap'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- monitorsLibraryManagement
summary: Create A Monitor Or Folder.
description: Create a monitor or folder in the monitors library.
operationId: monitorsCreate
parameters:
- name: parentId
in: query
description: Identifier of the parent folder in which to create the monitor or folder.
required: true
schema:
type: string
requestBody:
description: The monitor or folder to create.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBase'
required: true
responses:
'200':
description: The monitor or folder was created.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- monitorsLibraryManagement
summary: Bulk Delete A Monitor Or Folder.
description: Bulk delete a monitor or folder by the given identifiers in the monitors library.
operationId: monitorsDeleteByIds
parameters:
- name: ids
in: query
description: A comma-separated list of identifiers.
required: true
schema:
type: array
items:
type: string
example: 0000000000000001,0000000000000002,0000000000000003
responses:
'200':
description: A map between the deleted identifier and its metadata.
content:
application/json:
schema:
$ref: '#/components/schemas/IdToMonitorsLibraryBaseResponseMap'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/root:
get:
tags:
- monitorsLibraryManagement
summary: Get The Root Monitors Folder.
description: Get the root folder in the monitors library.
operationId: getMonitorsLibraryRoot
responses:
'200':
description: Root folder of the monitors library.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryFolderResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/path:
get:
tags:
- monitorsLibraryManagement
summary: Read A Monitor Or Folder By Its Path.
description: Read a monitor or folder by its path in the monitors library structure.
operationId: monitorsGetByPath
parameters:
- name: path
in: query
description: The path of the monitor or folder.
required: true
schema:
type: string
responses:
'200':
description: Requested monitor or folder.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/search:
get:
tags:
- monitorsLibraryManagement
summary: Search For A Monitor Or Folder.
description: Search for a monitor or folder in the monitors library structure.
operationId: monitorsSearch
parameters:
- name: query
in: query
description: "The search query to find monitor or folder. Below is the list of different filters with examples:\n - **createdBy** : Filter by the user's identifier who created the content. Example: `createdBy:000000000000968B`.\n - **createdBefore** : Filter by the content objects created before the given timestamp(in milliseconds). Example: `createdBefore:1457997222`.\n - **createdAfter** : Filter by the content objects created after the given timestamp(in milliseconds). Example: `createdAfter:1457997111`.\n - **modifiedBefore** : Filter by the content objects modified before the given timestamp(in milliseconds). Example: `modifiedBefore:1457997222`.\n - **modifiedAfter** : Filter by the content objects modified after the given timestamp(in milliseconds). Example: `modifiedAfter:1457997111`.\n - **type** : Filter by the type of the content object. Example: `type:folder`.\n - **monitorStatus** : Filter by the status of the monitor: Normal, Critical, Warning, MissingData, Disabled, AllTriggered. Example: `monitorStatus:Normal`.\n\nYou can also use multiple filters in one query. For example to search for all content objects created by user with identifier 000000000000968B with creation timestamp after 1457997222 containing the text Test, the query would look like:\n\n `createdBy:000000000000968B createdAfter:1457997222 Test`"
required: true
schema:
type: string
example: createdBy:000000000000968B Test
- name: limit
in: query
description: Maximum number of items you want in the response.
required: false
schema:
maximum: 5000
type: integer
format: int32
default: 1000
example: 10
- name: offset
in: query
description: The position or row from where to start the search operation.
required: false
schema:
type: integer
format: int32
default: 0
example: 5
- name: skipChildren
in: query
description: a boolean parameter to control skipping fetching children of requested folder(s)
required: false
schema:
type: boolean
responses:
'200':
description: List of folders and monitors matching the search query.
content:
application/json:
schema:
$ref: '#/components/schemas/ListMonitorsLibraryItemWithPath'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{id}:
get:
tags:
- monitorsLibraryManagement
summary: Get A Monitor Or Folder.
description: Get a monitor or folder from the monitors library.
operationId: monitorsReadById
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to read.
required: true
schema:
type: string
responses:
'200':
description: Requested monitor or folder.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- monitorsLibraryManagement
summary: Update A Monitor Or Folder.
description: 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.
operationId: monitorsUpdateById
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to update.
required: true
schema:
type: string
requestBody:
description: The monitor or folder to update. The content version must match its latest version number in the monitors library. If the version does not match it will not be updated.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseUpdate'
required: true
responses:
'200':
description: The monitor or folder was updated.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
delete:
tags:
- monitorsLibraryManagement
summary: Delete A Monitor Or Folder.
description: Delete a monitor or folder from the monitors library.
operationId: monitorsDeleteById
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to delete.
required: true
schema:
type: string
responses:
'204':
description: The monitor or folder was successfully deleted.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{id}/path:
get:
tags:
- monitorsLibraryManagement
summary: Get The Path Of A Monitor Or Folder.
description: Get the full path of the monitor or folder in the monitors library.
operationId: getMonitorsFullPath
parameters:
- name: id
in: path
description: Identifier of the monitor or folder.
required: true
schema:
type: string
responses:
'200':
description: Full path of the monitor or folder.
content:
application/json:
schema:
$ref: '#/components/schemas/Path'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{id}/move:
post:
tags:
- monitorsLibraryManagement
summary: Move A Monitor Or Folder.
description: Move a monitor or folder to a different location in the monitors library.
operationId: monitorsMove
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to move.
required: true
schema:
type: string
- name: parentId
in: query
description: Identifier of the parent folder to move the monitor or folder to.
required: true
schema:
type: string
responses:
'200':
description: Moved monitor or folder.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{id}/copy:
post:
tags:
- monitorsLibraryManagement
summary: Copy A Monitor Or Folder.
description: Copy a monitor or folder in the monitors library.
operationId: monitorsCopy
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to copy.
required: true
schema:
type: string
requestBody:
description: "Fields include:\n 1) Identifier of the parent folder to copy to.\n 2) Optionally provide a new name.\n 3) Optionally provide a new description.\n 4) Optionally set to true if you want to copy and preserve the locked status. Requires `LockMonitors` capability."
content:
application/json:
schema:
$ref: '#/components/schemas/ContentCopyParams'
required: true
responses:
'200':
description: The monitor or folder was copied.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{id}/export:
get:
tags:
- monitorsLibraryManagement
summary: Export A Monitor Or Folder.
description: Export a monitor or folder. If the given identifier is a folder, everything under the folder is exported recursively with folder as the root.
operationId: monitorsExportItem
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to export.
required: true
schema:
type: string
responses:
'200':
description: Exported monitor or folder.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseExport'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{parentId}/import:
post:
tags:
- monitorsLibraryManagement
summary: Import A Monitor Or Folder.
description: Import a monitor or folder.
operationId: monitorsImportItem
parameters:
- name: parentId
in: path
description: Identifier of the parent folder in which to import the monitor or folder.
required: true
schema:
type: string
requestBody:
description: The monitor or folder to be imported.
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseExport'
required: true
responses:
'200':
description: 'Newly imported monitor or folder. NOTE: Permissions field will not be filled (empty list).'
content:
application/json:
schema:
$ref: '#/components/schemas/MonitorsLibraryBaseResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/{id}/permissions:
get:
tags:
- monitorsLibraryManagement
summary: List Explicit Permissions On Monitor Or Folder.
description: List explicit permissions on monitor or folder in the monitors library.
operationId: monitorsReadPermissionsById
parameters:
- name: id
in: path
description: Identifier of the monitor or folder to list permissions.
required: true
schema:
type: string
responses:
'200':
description: The list of explicit permission statements for the monitor or folder.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPermissionsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/monitors/permissions/set:
put:
tags:
- monitorsLibraryManagement
summary: Set Permissions On Monitor Or Folder.
description: Set permissions on monitor or folder in the monitors library.
operationId: monitorsSetPermissions
requestBody:
description: The permission statement definitions to set.
content:
# --- truncated at 32 KB (66 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sumo-logic/refs/heads/main/openapi/sumo-logic-monitorslibrarymanagement-api-openapi.yml