{
"opencollection": "1.0.0",
"info": {
"name": "Sumo Logic API",
"version": "1.0.0"
},
"request": {
"auth": {
"type": "basic",
"username": "{{username}}",
"password": "{{password}}"
}
},
"items": [
{
"info": {
"name": "appManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List Available Apps.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/apps"
},
"docs": "Lists all available apps from the App Catalog."
},
{
"info": {
"name": "Get An App By UUID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/apps/:uuid",
"params": [
{
"name": "uuid",
"value": "",
"type": "path",
"description": "The identifier of the app to retrieve."
}
]
},
"docs": "Gets the app with the given universally unique identifier (UUID)."
},
{
"info": {
"name": "Install An App By UUID.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/apps/:uuid/install",
"params": [
{
"name": "uuid",
"value": "",
"type": "path",
"description": "UUID of the app to install."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Installs the app with given UUID in the folder specified using destinationFolderId."
},
{
"info": {
"name": "App Install Job Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/apps/install/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous install job."
}
]
},
"docs": "Get the status of an asynchronous app install request for the given job identifier."
}
]
},
{
"info": {
"name": "appManagementV2",
"type": "folder"
},
"items": [
{
"info": {
"name": "Start App Install Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/install",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app to install."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedule an asynchronous job to install the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.\n\n_You get back an identifier of asynchronous job in response to this endpoint. You can then use the [app install status API](#operation/getAsyncInstallAppStatus) to get the status of the installation request. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to wor"
},
{
"info": {
"name": "App Install Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/apps/install/:jobId/status",
"params": [
{
"name": "jobId",
"value": "C03E086C137F38B4",
"type": "path",
"description": "Identifier of the asynchronous job for installing the app."
}
]
},
"docs": "Get the status of an asynchronous app install request for the given job identifier."
},
{
"info": {
"name": "Start App Uninstall Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/uninstall",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app to uninstall."
}
]
},
"docs": "Schedule an asynchronous job to uninstall app with the given UUID.\n\n_You get back an identifier of asynchronous job in response to this endpoint. You can then use the [app uninstall status API](#operation/getAsyncUninstallAppStatus) to get the status of the uninstallation request. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work with asynchronous request._"
},
{
"info": {
"name": "App Uninstall Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/apps/uninstall/:jobId/status",
"params": [
{
"name": "jobId",
"value": "C03E086C137F38B4",
"type": "path",
"description": "Identifier of the asynchronous job for uninstalling the app."
}
]
},
"docs": "Get the status of an asynchronous app uninstall request for the given job identifier."
},
{
"info": {
"name": "Start App Upgrade Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/upgrade",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app to upgrade."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedule an asynchronous job to upgrade the app with the given UUID and version from the App Catalog. The app will be installed in 'Installed Apps' folder in the Content Library.\n\n_You get back an identifier of asynchronous job in response to this endpoint. You can then use the [app upgrade status API](#operation/getAsyncUpgradeAppStatus) to get the status of the upgrade request. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work wit"
},
{
"info": {
"name": "App Upgrade Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/apps/upgrade/:jobId/status",
"params": [
{
"name": "jobId",
"value": "C03E086C137F38B4",
"type": "path",
"description": "Identifier of the asynchronous job for upgrading the app."
}
]
},
"docs": "Get the status of an asynchronous app upgrade request for the given job identifier."
},
{
"info": {
"name": "List Apps",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/apps",
"params": [
{
"name": "name",
"value": "AWS%20CloudTrail",
"type": "query",
"description": "Name of the app."
},
{
"name": "author",
"value": "Sumo%20Logic",
"type": "query",
"description": "Author of the app."
}
]
},
"docs": "List all apps from the App Catalog."
},
{
"info": {
"name": "Get Details Of An App Version.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/details",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app."
},
{
"name": "version",
"value": "1.0.0",
"type": "query",
"description": "Version of the app. The latest version is used if this is omitted or specified as \"latest\"."
}
]
},
"docs": "Get details about an app with the given UUID and version. The details include:\n\n 1. The base URL for all the resource for the app.\n 2. The app manifest"
},
{
"info": {
"name": "Get Subscription Status For The User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/subscription",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app."
}
]
},
"docs": "Get Subscription status for the user for a specific app. This will indicate whether the user has subscribed to the app or not."
},
{
"info": {
"name": "Subscribe To An App Upgrade Notification",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/subscription",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app to subscribe to."
}
]
},
"docs": "Subscribe to an app upgrade notification. This will allow the user to receive notifications for the app updates."
},
{
"info": {
"name": "Unsubscribe From An App Upgrade Notification",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/apps/:uuid/subscription",
"params": [
{
"name": "uuid",
"value": "ceb7fac5-1127-4a04-a5b8-2e49190be3d5",
"type": "path",
"description": "UUID of the app to unsubscribe from."
}
]
},
"docs": "Unsubscribe from an app. This will remove the user's subscription to notifications for the app."
}
]
},
{
"info": {
"name": "connectionManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Connections.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/connections",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of connections returned in the response. The number of connections returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of all connections in the organization. The response is paginated with a default limit of 100 connections per page."
},
{
"info": {
"name": "Create A New Connection.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/connections",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new connection in the organization."
},
{
"info": {
"name": "Test A New Connection Url.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/connections/test",
"params": [
{
"name": "functionalities",
"value": "alert,resolution",
"type": "query",
"description": "A comma-separated functionalities of webhook payload to test. Acceptable values: `alert`, `resolution`."
},
{
"name": "connectionId",
"value": "0000000000123ABC",
"type": "query",
"description": "Unique identifier of an existing connection to test. It should be provided when the request body of an existing connection contains masked authorization headers. If not provided, the authorization headers will not be correctly unmasked, and the test may fail due to unauthorized access."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Test a new connection url is valid and can connect."
},
{
"info": {
"name": "Get Incident Templates For CloudSOAR Connections.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/connections/incidentTemplates",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get incident templates for CloudSOAR connections."
},
{
"info": {
"name": "Get A Connection.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of connection to return."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of connection to return. Valid values are `WebhookConnection`, `ServiceNowConnection`."
}
]
},
"docs": "Get a connection with the given identifier."
},
{
"info": {
"name": "Update A Connection.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the connection to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing connection."
},
{
"info": {
"name": "Delete A Connection.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/connections/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the connection to delete."
},
{
"name": "type",
"value": "",
"type": "query",
"description": "Type of connection to delete. Valid values are `WebhookConnection`, `ServiceNowConnection`."
}
]
},
"docs": "Delete a connection with the given identifier."
}
]
},
{
"info": {
"name": "scheduledViewManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Scheduled Views.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of scheduled views returned in the response. The number of scheduled views returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of all scheduled views in the organization. The response is paginated with a default limit of 100 scheduled views per page."
},
{
"info": {
"name": "Create A New Scheduled View.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new scheduled view in the organization."
},
{
"info": {
"name": "Get A Scheduled View.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the scheduled view to fetch."
}
]
},
"docs": "Get a scheduled view with the given identifier."
},
{
"info": {
"name": "Update A Scheduled View.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the scheduled view to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing scheduled view."
},
{
"info": {
"name": "Disable A Scheduled View.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews/:id/disable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the scheduled view to disable."
}
]
},
"docs": "Disable a scheduled view with the given identifier."
},
{
"info": {
"name": "Pause A Scheduled View.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews/:id/pause",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the scheduled view to pause."
}
]
},
"docs": "Pause a scheduled view with the given identifier."
},
{
"info": {
"name": "Start A Scheduled View.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews/:id/start",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the scheduled view to start."
}
]
},
"docs": "Start a scheduled view with the given identifier."
},
{
"info": {
"name": "Provides Information About Scheduled Views Quota.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/scheduledViews/quota"
},
"docs": "Every customer can use a limited number of scheduled views. This endpoint allows learning about these limitations and remaining quota."
}
]
},
{
"info": {
"name": "lookupManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create A Lookup Table.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/lookupTables",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new lookup table by providing a schema and specifying its configuration. Providing parentFolderId\n is mandatory. Use the [getItemByPath](#operation/getItemByPath) endpoint to get content id of a path.\nPlease check [Content management API](#tag/contentManagement) and [Folder management API](#tag/folderManagement) for all available options."
},
{
"info": {
"name": "Get A Lookup Table.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the lookup table."
}
]
},
"docs": "Get a lookup table for the given identifier."
},
{
"info": {
"name": "Edit A Lookup Table.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the lookup table."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Edit the lookup table data. All the fields are mandatory in the request."
},
{
"info": {
"name": "Delete A Lookup Table.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the lookup table."
}
]
},
"docs": "Delete a lookup table completely.
**Warning:** `This operation cannot be undone`."
},
{
"info": {
"name": "Upload A CSV File.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id/upload",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the lookup table to populate."
},
{
"name": "merge",
"value": "",
"type": "query",
"description": "This indicates whether the file contents will be merged with existing data in the lookup table or not. If this is true then data with the same primary keys will be updated while the rest of the rows will be appended. By default, merge is false. The response includes a request identifier that you need to use in the [Request Status API](#operation/requestStatus) to track the status of the upload request."
},
{
"name": "fileEncoding",
"value": "",
"type": "query",
"description": "File encoding of file being uploaded."
}
],
"body": {
"type": "multipart-form",
"data": [
{
"name": "file",
"type": "text",
"value": ""
}
]
}
},
"docs": "Create a request to populate a lookup table with a CSV file."
},
{
"info": {
"name": "Get The Status Of An Async Job.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/jobs/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "An identifier returned in response to an asynchronous request."
}
]
},
"docs": "Retrieve the status of a previously made request. If the request was successful, the status of the response object will be `Success`."
},
{
"info": {
"name": "Empty A Lookup Table.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id/truncate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the table to clear."
}
]
},
"docs": "Delete all data from a lookup table."
},
{
"info": {
"name": "Insert Or Update A Lookup Table Row.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id/row",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the lookup table."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Insert or update a row of a lookup table with the given identifier. A new row is inserted if the primary key does not exist already, otherwise the existing row with the specified primary key is updated. All the fields of the lookup table are required and will be updated to the given values. In case a field is not specified then it will be assumed to be set to null. If the table size exceeds the maximum limit of 100MB then based on the size limit action of the table the update will be processed o"
},
{
"info": {
"name": "Delete A Lookup Table Row.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/lookupTables/:id/deleteTableRow",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the lookup table."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Delete a row from lookup table by providing the row's primary keys' values. The complete set of primary key fields of the lookup table should be provided."
}
]
},
{
"info": {
"name": "partitionManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Partitions.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/partitions",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of partitions returned in the response. The number of partitions returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "viewTypes",
"value": "AuditIndex,Partition",
"type": "query",
"description": "The type of partitions to retrieve. Valid values are:\n 1. `DefaultView`: To get General Index partition.\n 2. `Partition`: To get user defined views/partitions.\n 3. `AuditIndex`: To get the internal audit indexes. Eg. sumologic_audit_events.\n\nMore than one type of partitions can be retrieved in same request."
}
]
},
"docs": "Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page."
},
{
"info": {
"name": "Create A New Partition.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/partitions",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new partition."
},
{
"info": {
"name": "Get A Partition.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/partitions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of partition to return."
}
]
},
"docs": "Get a partition with the given identifier from the organization."
},
{
"info": {
"name": "Update A Partition.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/partitions/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the partition to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing partition in the organization."
},
{
"info": {
"name": "Decommission A Partition.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/partitions/:id/decommission",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the partition to decommission."
}
]
},
"docs": "Decommission a partition with the given identifier from the organization."
},
{
"info": {
"name": "Cancel A Retention Update For A Partition",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/partitions/:id/cancelRetentionUpdate",
"params": [
{
"name": "id",
"value": "1",
"type": "path",
"description": "Identifier of the partition to cancel the retention update for."
}
]
},
"docs": "Cancel update to retention of a partition for which retention was updated previously using `reduceRetentionPeriodImmediately` parameter as false"
},
{
"info": {
"name": "Provides Information About Partitions Quota.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/partitions/quota"
},
"docs": "Every customer can use a limited number of partitions. This endpoint allows learning about these limitations and remaining quota."
}
]
},
{
"info": {
"name": "logsDataForwardingManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Amazon S3 Data Forwarding Destinations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/destinations",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of data forwarding destinations returned in the response. The number of data forwarding destinations returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of all Amazon S3 data forwarding destinations."
},
{
"info": {
"name": "Create An S3 Data Forwarding Destination.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/destinations",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new Amazon S3 data forwarding destination."
},
{
"info": {
"name": "Get An S3 Data Forwarding Destination.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/destinations/:id",
"params": [
{
"name": "id",
"value": "1",
"type": "path",
"description": "Identifier of the S3 data forwarding destination to return."
}
]
},
"docs": "Get an S3 data forwarding destination by the given identifier."
},
{
"info": {
"name": "Update An S3 Data Forwarding Destination.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/destinations/:id",
"params": [
{
"name": "id",
"value": "1",
"type": "path",
"description": "Identifier of the data forwarding destination to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an S3 data forwarding destination by the given identifier."
},
{
"info": {
"name": "Delete An S3 Data Forwarding Destination.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/destinations/:id",
"params": [
{
"name": "id",
"value": "1",
"type": "path",
"description": "Identifier of the data forwarding destination to delete."
}
]
},
"docs": "Delete an existing Amazon S3 data forwarding destination with the given identifier."
},
{
"info": {
"name": "Get All S3 Data Forwarding Rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/rules",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of data forwarding rules returned in the response. The number of data forwarding rules returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of all S3 data forwarding rules."
},
{
"info": {
"name": "Create An S3 Data Forwarding Rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/rules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a data forwarding rule to send data from a Partition or Scheduled View to an S3 bucket."
},
{
"info": {
"name": "Get An S3 Data Forwarding Rule By Its Index.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/rules/:indexId",
"params": [
{
"name": "indexId",
"value": "1",
"type": "path",
"description": "The `id` of the Partition or Scheduled View."
}
]
},
"docs": "Get the details of an S3 data forwarding rule by its Partition or Scheduled View identifier."
},
{
"info": {
"name": "Update An S3 Data Forwarding Rule By Its Index.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/rules/:indexId",
"params": [
{
"name": "indexId",
"value": "1",
"type": "path",
"description": "The `id` of the Partition or Scheduled View with the data forwarding rule to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an S3 data forwarding rule by its Partition or Scheduled View identifier."
},
{
"info": {
"name": "Delete An S3 Data Forwarding Rule By Its Index.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/logsDataForwarding/rules/:indexId",
"params": [
{
"name": "indexId",
"value": "1",
"type": "path",
"description": "The `id` of the Partition or Scheduled View with the data forwarding rule to delete."
}
]
},
"docs": "Delete an S3 data forwarding rule by its Partition or Scheduled View identifier."
}
]
},
{
"info": {
"name": "logSearchesManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Saved Log Searches.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/logSearches",
"params": [
{
"name": "limit",
"value": "50",
"type": "query",
"description": "Limit the number of log searches returned in the response. The number of log searches returned may be less than the `limit`."
},
{
"name": "token",
"value": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "List all saved log searches viewable by the user."
},
{
"info": {
"name": "Save A Log Search.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logSearches",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Save the log search in the content library."
},
{
"info": {
"name": "Get The Saved Log Search.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/logSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the saved log search."
}
]
},
"docs": "Get a saved log search from the content library by identifier."
},
{
"info": {
"name": "Update The Saved Log Search.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/logSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the saved log search."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the saved log search with the specified identifier. Partial update is not supported, you must provide values for all fields."
},
{
"info": {
"name": "Delete The Saved Log Search.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/logSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the saved log search."
}
]
},
"docs": "Delete the saved log search from the content library."
}
]
},
{
"info": {
"name": "dataDeletionRules",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Data Deletion Rules",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dataDeletionRules",
"params": [
{
"name": "limit",
"value": "100",
"type": "query",
"description": "Limit the number of deletion Rules returned in the response"
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of data deletion rules in the organization. The response is paginated with a default limit of 50 rules."
},
{
"info": {
"name": "Create A New Data Deletion Rule",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/dataDeletionRules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new data deletion rule to delete logs."
},
{
"info": {
"name": "Get Data Deletion Rule Information For The Given Id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dataDeletionRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the Deletion Rule to fetch"
}
]
},
"docs": "Get Data Deletion Rule information for the given Id with updated fields."
},
{
"info": {
"name": "Cancel The Data Deletion Rule With The Given Id.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/dataDeletionRules/:id/cancel",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the Deletion Rule to cancel"
}
]
},
"docs": "Cancel the data Deletion Rule with the given Id. Allowed only if the rule is waiting for approval."
},
{
"info": {
"name": "Delete The Data Deletion Rule With The Given Id.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/dataDeletionRules/:id/delete",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the Deletion Rule to delete"
}
]
},
"docs": "Delete the data Deletion Rule with the given Id. Allowed only if the rule is cancelled."
}
]
},
{
"info": {
"name": "dataMaskingManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Data Masking Rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dataMaskingRules",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of data masking rules returned in the response. The number of rules returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results."
}
]
},
"docs": "Get a list of all data masking rules for the current organization. The response is paginated with a default limit of 100 rules per page."
},
{
"info": {
"name": "Create A New Data Masking Rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/dataMaskingRules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new data masking rule. The rule will be applied to search results at query time, replacing matches of the regex pattern with the specified mask string."
},
{
"info": {
"name": "Get A Data Masking Rule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dataMaskingRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the data masking rule to return."
}
]
},
"docs": "Get a data masking rule with the given identifier."
},
{
"info": {
"name": "Update A Data Masking Rule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/dataMaskingRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the data masking rule to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing data masking rule. All properties specified in the request are replaced. Missing properties are set to their default values. The rule name is immutable and cannot be changed after creation."
},
{
"info": {
"name": "Delete A Data Masking Rule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/dataMaskingRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the data masking rule to delete."
}
]
},
"docs": "Delete a data masking rule with the given identifier."
}
]
},
{
"info": {
"name": "extractionRuleManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Field Extraction Rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/extractionRules",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of field extraction rules returned in the response. The number of field extraction rules returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results."
}
]
},
"docs": "Get a list of all field extraction rules. The response is paginated with a default limit of 100 field extraction rules per page."
},
{
"info": {
"name": "Create A New Field Extraction Rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/extractionRules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new field extraction rule."
},
{
"info": {
"name": "Get A Field Extraction Rule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/extractionRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of field extraction rule to return."
}
]
},
"docs": "Get a field extraction rule with the given identifier."
},
{
"info": {
"name": "Update A Field Extraction Rule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/extractionRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the field extraction rule to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing field extraction rule. All properties specified in the request are replaced. Missing properties are set to their default values."
},
{
"info": {
"name": "Delete A Field Extraction Rule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/extractionRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the field extraction rule to delete."
}
]
},
"docs": "Delete a field extraction rule with the given identifier."
}
]
},
{
"info": {
"name": "dynamicParsingRuleManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Dynamic Parsing Rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dynamicParsingRules",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of dynamic parsing rules returned in the response. The number of dynamic parsing rules returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results."
}
]
},
"docs": "Get a list of all dynamic parsing rules. The response is paginated with a default limit of 100 dynamic parsing rules per page."
},
{
"info": {
"name": "Create A New Dynamic Parsing Rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/dynamicParsingRules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new dynamic parsing rule."
},
{
"info": {
"name": "Get A Dynamic Parsing Rule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dynamicParsingRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of dynamic parsing rule to return."
}
]
},
"docs": "Get a dynamic parsing rule with the given identifier."
},
{
"info": {
"name": "Update A Dynamic Parsing Rule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/dynamicParsingRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the dynamic parsing rule to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing dynamic parsing rule. All properties specified in the request are replaced. Missing properties are set to their default values."
},
{
"info": {
"name": "Delete A Dynamic Parsing Rule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/dynamicParsingRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the dynamic parsing rule to delete."
}
]
},
"docs": "Delete a dynamic parsing rule with the given identifier."
}
]
},
{
"info": {
"name": "fieldManagementV1",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of All Custom Fields.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/fields"
},
"docs": "Request a list of all the custom fields configured in your account."
},
{
"info": {
"name": "Create A New Field.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/fields",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Adding a field will define it in the Fields schema allowing it to be assigned as metadata to your logs."
},
{
"info": {
"name": "Get A Custom Field.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/fields/:id",
"params": [
{
"name": "id",
"value": "00000000031D02DA",
"type": "path",
"description": "Identifier of a field."
}
]
},
"docs": "Get the details of a custom field."
},
{
"info": {
"name": "Delete A Custom Field.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/fields/:id",
"params": [
{
"name": "id",
"value": "00000000031D02DA",
"type": "path",
"description": "Identifier of a field to delete."
}
]
},
"docs": "Deleting a field does not delete historical data assigned with that field. If you delete a field by mistake and one or more of those dependencies break, you can re-add the field to get things working properly again. You should always disable a field and ensure things are behaving as expected before deleting a field."
},
{
"info": {
"name": "Enable Custom Field With A Specified Identifier.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/fields/:id/enable",
"params": [
{
"name": "id",
"value": "00000000031D02DA",
"type": "path",
"description": "Identifier of a field to enable."
}
]
},
"docs": "Fields have to be enabled to be assigned to your data. This operation ensures that a specified field is enabled and Sumo Logic will treat it as safe to process. All manually created custom fields are enabled by default."
},
{
"info": {
"name": "Disable A Custom Field.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/fields/:id/disable",
"params": [
{
"name": "id",
"value": "00000000031D02DA",
"type": "path",
"description": "Identifier of a field to disable."
}
]
},
"docs": "After disabling a field Sumo Logic will start dropping its incoming values at ingest. As a result, they won't be searchable or usable. Historical values are not removed and remain searchable."
},
{
"info": {
"name": "Get A List Of Dropped Fields.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/fields/dropped"
},
"docs": "Dropped fields are fields sent to Sumo Logic, but are ignored since they are not defined in your Fields schema. In order to save these values a field must both exist and be enabled."
},
{
"info": {
"name": "Get A List Of Built-in Fields.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/fields/builtin"
},
"docs": "Built-in fields are created automatically by Sumo Logic for standard configuration purposes. They include `_sourceHost` and `_sourceCategory`. Built-in fields can't be deleted or disabled."
},
{
"info": {
"name": "Get A Built-in Field.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/fields/builtin/:id",
"params": [
{
"name": "id",
"value": "000000000000000A",
"type": "path",
"description": "Identifier of a built-in field."
}
]
},
"docs": "Get the details of a built-in field."
},
{
"info": {
"name": "Get Capacity Information.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/fields/quota"
},
"docs": "Every account has a limited number of fields available. This endpoint returns your account limitations and remaining quota."
}
]
},
{
"info": {
"name": "ingestBudgetManagementV2",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Ingest Budgets.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/ingestBudgets",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of budgets returned in the response. The number of budgets returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results."
}
]
},
"docs": "Get a list of all ingest budgets. The response is paginated with a default limit of 100 budgets per page."
},
{
"info": {
"name": "Create A New Ingest Budget.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/ingestBudgets",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new ingest budget."
},
{
"info": {
"name": "Get An Ingest Budget.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/ingestBudgets/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of ingest budget to return."
}
]
},
"docs": "Get an ingest budget by the given identifier."
},
{
"info": {
"name": "Update An Ingest Budget.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/ingestBudgets/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the ingest budget to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing ingest budget. All properties specified in the request are required."
},
{
"info": {
"name": "Delete An Ingest Budget.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/ingestBudgets/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the ingest budget to delete."
}
]
},
"docs": "Delete an ingest budget with the given identifier."
},
{
"info": {
"name": "Reset Usage.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/ingestBudgets/:id/usage/reset",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the ingest budget to reset usage."
}
]
},
"docs": "Reset ingest budget's current usage to 0 before the scheduled reset time. This is only applicable to `dailyVolume` budgetType."
}
]
},
{
"info": {
"name": "userManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Users.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/users",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of users returned in the response. The number of users returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Sort the list of users by the `firstName`, `lastName`, or `email` field."
},
{
"name": "email",
"value": "",
"type": "query",
"description": "Find user with the given email address."
},
{
"name": "includeServiceAccounts",
"value": "",
"type": "query",
"description": "Include service accounts while listing users within the organization."
}
]
},
"docs": "Get a list of all users in the organization. The response is paginated with a default limit of 100 users per page."
},
{
"info": {
"name": "Create A New User.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/users",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new user in the organization."
},
{
"info": {
"name": "Get A User.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of user to return."
}
]
},
"docs": "Get a user with the given identifier from the organization."
},
{
"info": {
"name": "Update A User.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the user to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing user in the organization."
},
{
"info": {
"name": "Delete A User.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the user to delete."
},
{
"name": "transferTo",
"value": "",
"type": "query",
"description": "Identifier of the user to receive the transfer of content from the deleted user.
**Note:** If `deleteContent` is not set to `true`, and no user identifier is specified in `transferTo`, content from the deleted user is transferred to the executing user."
},
{
"name": "deleteContent",
"value": "",
"type": "query",
"description": "Whether to delete content from the deleted user or not.
**Warning:** If `deleteContent` is set to `true`, all of the content for the user being deleted is permanently deleted and cannot be recovered."
}
]
},
"docs": "Delete a user with the given identifier from the organization and transfer their content to the user with the identifier specified in \"transferTo\"."
},
{
"info": {
"name": "Change Email Address.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/users/:id/email/requestChange",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the user to change email address."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "An email with an activation link is sent to the user’s new email address. The user must click the link in the email within seven days to complete the email address change, or the link will expire."
},
{
"info": {
"name": "Reset Password.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/users/:id/password/reset",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the user to reset password."
}
]
},
"docs": "Reset a user's password."
},
{
"info": {
"name": "Unlock A User.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/users/:id/unlock",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the user that needs to be unlocked."
}
]
},
"docs": "Unlock another user's account."
},
{
"info": {
"name": "Disable MFA For User.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/users/:id/mfa/disable",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the user to disable MFA for."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Disable multi-factor authentication for given user."
},
{
"info": {
"name": "Resend Verification Email.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/users/:id/resendWelcomeEmail",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the user to resend the welcome email."
}
]
},
"docs": "Resend the welcome email to a user."
}
]
},
{
"info": {
"name": "roleManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Roles.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/roles",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of roles returned in the response. The number of roles returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Sort the list of roles by the `name` field."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Only return roles matching the given name."
}
]
},
"docs": "Get a list of all the roles in the organization. The response is paginated with a default limit of 100 roles per page."
},
{
"info": {
"name": "Create A New Role.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/roles",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new role in the organization."
},
{
"info": {
"name": "Get A Role.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the role to fetch."
}
]
},
"docs": "Get a role with the given identifier in the organization."
},
{
"info": {
"name": "Update A Role.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the role to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing role in the organization."
},
{
"info": {
"name": "Delete A Role.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the role to delete."
}
]
},
"docs": "Delete a role with the given identifier from the organization."
},
{
"info": {
"name": "Assign A Role To A User.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/roles/:roleId/users/:userId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Identifier of the role to assign."
},
{
"name": "userId",
"value": "",
"type": "path",
"description": "Identifier of the user to assign the role to."
}
]
},
"docs": "Assign a role to a user in the organization."
},
{
"info": {
"name": "Remove Role From A User.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/roles/:roleId/users/:userId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Identifier of the role to delete."
},
{
"name": "userId",
"value": "",
"type": "path",
"description": "Identifier of the user to remove the role from."
}
]
},
"docs": "Remove a role from a user in the organization."
}
]
},
{
"info": {
"name": "roleManagementV2",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Roles.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/roles",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of roles returned in the response. The number of roles returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Sort the list of roles by the `name` field."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Only return roles matching the given name."
}
]
},
"docs": "Get a list of all the roles in the organization. The response is paginated with a default limit of 100 roles per page."
},
{
"info": {
"name": "Create A New Role.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/roles",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new role in the organization."
},
{
"info": {
"name": "Get A Role.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the role to fetch."
}
]
},
"docs": "Get a role with the given identifier in the organization."
},
{
"info": {
"name": "Update A Role.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the role to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing role in the organization."
},
{
"info": {
"name": "Delete A Role.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/roles/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the role to delete."
}
]
},
"docs": "Delete a role with the given identifier from the organization."
},
{
"info": {
"name": "Assign A Role To A User.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/roles/:roleId/users/:userId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Identifier of the role to assign."
},
{
"name": "userId",
"value": "",
"type": "path",
"description": "Identifier of the user to assign the role to."
}
]
},
"docs": "Assign a role to a user in the organization."
},
{
"info": {
"name": "Remove Role From A User.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/roles/:roleId/users/:userId",
"params": [
{
"name": "roleId",
"value": "",
"type": "path",
"description": "Identifier of the role to delete."
},
{
"name": "userId",
"value": "",
"type": "path",
"description": "Identifier of the user to remove the role from."
}
]
},
"docs": "Remove a role from a user in the organization."
}
]
},
{
"info": {
"name": "folderManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Create A New Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/content/folders",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new folder under the given parent folder. Set the header parameter `isAdminMode` to `\"true\"` to create a folder inside \"Admin Recommended\" folder."
},
{
"info": {
"name": "Get A Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/:id",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder to fetch."
}
]
},
"docs": "Get a folder with the given identifier. Set the header parameter `isAdminMode` to `\"true\"` if fetching a folder inside \"Admin Recommended\" folder."
},
{
"info": {
"name": "Update A Folder.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/content/folders/:id",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing folder with the given identifier. Set the header parameter `isAdminMode` to `\"true\"` if updating a folder inside \"Admin Recommended\" folder."
},
{
"info": {
"name": "Get Personal Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/personal"
},
"docs": "Get the personal folder of the current user."
},
{
"info": {
"name": "Schedule Global View Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/global",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
]
},
"docs": "Schedule an asynchronous job to get Global View. Global View contains all top-level content items that a user has permissions to view in the organization. User can traverse the top-level folders using [GetFolder API](#operation/getFolder) to get rest of the content items. Make sure you set `isAdminMode` header parameter to `true` when traversing top-level items.\n\n_Global View is not a real folder, therefore there is no folder identifier associated with it_.\n\n_You get back a identifier of asynchr"
},
{
"info": {
"name": "Get Global View Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/global/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Global View job."
}
]
},
"docs": "Get the status of an asynchronous Global View job for the given job identifier. If job succeeds, use [Global View Result](#operation/getGlobalFolderAsyncResult) endpoint to fetch all content items that you have permissions to view."
},
{
"info": {
"name": "Get Global View Job Result",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/global/:jobId/result",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Global View job."
}
]
},
"docs": "Get result of a Global View job for the given job identifier. The result will be a list of all content items that a user has permissions to view in the organization."
},
{
"info": {
"name": "Schedule Admin Recommended Folder Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/adminRecommended",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
]
},
"docs": "Schedule an asynchronous job to get the top-level Admin Recommended content items. You can read more about Admin Recommended folder [here](https://help.sumologic.com/Manage/Content_Sharing/Admin_Mode#move-important-content-to-admin-recommended).\n\n_You get back a identifier of asynchronous job in response to this endpoint. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work with asynchronous request._"
},
{
"info": {
"name": "Get Admin Recommended Folder Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/adminRecommended/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Admin Recommended folder job."
}
]
},
"docs": "Get the status of an asynchronous Admin Recommended folder job for the given job identifier. If job succeeds, use [Admin Recommended Job Result](#operation/getAdminRecommendedFolderAsyncResult) endpoint to fetch top-level content items in Admin Recommended folder."
},
{
"info": {
"name": "Get Admin Recommended Folder Job Result",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/adminRecommended/:jobId/result",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Admin Recommended folder job."
}
]
},
"docs": "Get result of an Admin Recommended job for the given job identifier. The result will be \"Admin Recommended\" folder with a list of top-level Admin Recommended content items in `children` field."
},
{
"info": {
"name": "Schedule Installed Apps Folder Job",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/installedApps",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
]
},
"docs": "Schedule an asynchronous job to get the top-level Installed Apps content items.\n\n_You get back a identifier of asynchronous job in response to this endpoint. See [Asynchronous-Request](#section/Getting-Started/Asynchronous-Request) section for more details on how to work with asynchronous request._"
},
{
"info": {
"name": "Get Installed Apps Folder Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/installedApps/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Installed Apps folder job."
}
]
},
"docs": "Get the status of an asynchronous Installed Apps folder job for the given job identifier. If job succeeds, use [Installed Apps Job Result](#operation/getInstalledAppsFolderAsyncResult) endpoint to fetch top-level content items in Installed Apps folder."
},
{
"info": {
"name": "Get Installed Apps Folder Job Result",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/installedApps/:jobId/result",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Installed Apps folder job."
}
]
},
"docs": "Get result of an Installed Apps job for the given job identifier. The result will be \"Installed Apps\" folder with a list of top-level Installed Apps content items in `children` field."
}
]
},
{
"info": {
"name": "contentPermissions",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Permissions Of A Content Item",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/:id/permissions",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the content item."
},
{
"name": "explicitOnly",
"value": "",
"type": "query",
"description": "There are two permission types: explicit and implicit. Permissions specifically assigned to the content item are explicit. Permissions derived from a parent content item, like a folder are implicit. To return only explicit permissions set this to true."
}
]
},
"docs": "Returns content permissions of a content item with the given identifier."
},
{
"info": {
"name": "Add Permissions To A Content Item.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/content/:id/permissions/add",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the content item."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add permissions to a content item with the given identifier."
},
{
"info": {
"name": "Remove Permissions From A Content Item.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/content/:id/permissions/remove",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the content item."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Remove permissions from a content item with the given identifier."
}
]
},
{
"info": {
"name": "contentManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Content Item By Path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/path",
"params": [
{
"name": "path",
"value": "/Library/Users/user@sumo.com/SampleFolder",
"type": "query",
"description": "Path of the content item to retrieve."
}
]
},
"docs": "Get a content item corresponding to the given path.\n\n_Path is specified in the required query parameter `path`. The path should be URL encoded._ For example, to get \"Acme Corp\" folder of a user \"user@sumo.com\" you can use the following curl command:\n ```bash\n curl https://api.sumologic.com/api/v2/content/path?path=/Library/Users/user%40sumo.com/Acme%20Corp\n ```\n\n\nThe absolute path to a content item should be specified to get the item. The content library has \"Library\" folder at the root level"
},
{
"info": {
"name": "Get Path Of An Item.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/:contentId/path",
"params": [
{
"name": "contentId",
"value": "",
"type": "path",
"description": "Identifier of the content item to get the path."
}
]
},
"docs": "Get full path of a content item with the given identifier.\n"
},
{
"info": {
"name": "Start A Content Export Job.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/content/:id/export",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the content item to export. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format."
}
]
},
"docs": "Schedule an _asynchronous_ export of content with the given identifier. You will get back an asynchronous job identifier on success. Use the [getAsyncExportStatus](#operation/getAsyncExportStatus) endpoint and the job identifier you got back in the response to track the status of an asynchronous export job.\nIf the content item is a folder, everything under the folder is exported recursively. Keep in mind when exporting large folders that there is a limit of 1000 content objects that can be expor"
},
{
"info": {
"name": "Content Export Job Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/:contentId/export/:jobId/status",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "contentId",
"value": "",
"type": "path",
"description": "The identifier of the exported content item."
},
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous export job."
}
]
},
"docs": "Get the status of an asynchronous content export request for the given job identifier. On success, use the [getExportResult](#operation/getAsyncExportResult) endpoint to get the result of the export job."
},
{
"info": {
"name": "Content Export Job Result.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/:contentId/export/:jobId/result",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "contentId",
"value": "",
"type": "path",
"description": "The identifier of the exported content item."
},
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous job."
}
]
},
"docs": "Get results from content export job for the given job identifier. The results from this export are incompatible with the Library import feature in the Sumo user interface."
},
{
"info": {
"name": "Start A Content Import Job.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/content/folders/:folderId/import",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "folderId",
"value": "",
"type": "path",
"description": "The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format."
},
{
"name": "overwrite",
"value": "",
"type": "query",
"description": "Set this to \"true\" to overwrite a content item if the name already exists."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedule an asynchronous import of content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the `overwrite` parameter to `true` to overwrite existing content items. By default, the `overwrite` parameter is set to `false`, where the import will fail if a content item with the same"
},
{
"info": {
"name": "Content Import Job Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/:folderId/import/:jobId/status",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "folderId",
"value": "",
"type": "path",
"description": "The identifier of the folder to import into."
},
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the import request."
}
]
},
"docs": "Get the status of a content import job for the given job identifier."
},
{
"info": {
"name": "Content Import Job Result.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/folders/:folderId/import/:jobId/result",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "folderId",
"value": "",
"type": "path",
"description": "The identifier of the folder to import into."
},
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the import request."
}
]
},
"docs": "Get the complete summary of content import job for the given job identifier."
},
{
"info": {
"name": "Start A Content Deletion Job.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/content/:id/delete",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the content to delete. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format."
}
]
},
"docs": "Start an asynchronous content deletion job with the given identifier."
},
{
"info": {
"name": "Content Deletion Job Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/:id/delete/:jobId/status",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the content to delete."
},
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous job."
}
]
},
"docs": "Get the status of an asynchronous content deletion job request for the given job identifier."
},
{
"info": {
"name": "Start A Content Copy Job.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/content/:id/copy",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the content item to copy. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format."
},
{
"name": "destinationFolder",
"value": "",
"type": "query",
"description": "The identifier of the destination folder."
}
]
},
"docs": "Start an asynchronous content copy job with the given identifier to the destination folder. If the content item is a folder, everything under the folder is copied recursively."
},
{
"info": {
"name": "Content Copy Job Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/content/:id/copy/:jobId/status",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the content which was copied."
},
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous copy request job."
}
]
},
"docs": "Get the status of the copy request with the given job identifier. On success, field `statusMessage` will contain identifier of the newly copied content in format: `id: {hexIdentifier}`.\n"
},
{
"info": {
"name": "Move An Item.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/content/:id/move",
"headers": [
{
"name": "isAdminMode",
"value": ""
}
],
"params": [
{
"name": "destinationFolderId",
"value": "",
"type": "query",
"description": "Identifier of the destination folder."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the item the user wants to move."
}
]
},
"docs": "Moves an item from its current location to another folder.\n"
}
]
},
{
"info": {
"name": "transformationRuleManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Transformation Rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/transformationRules",
"params": [
{
"name": "limit",
"value": "10",
"type": "query",
"description": "Limit the number of transformation rules returned in the response."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of transformation rules in the organization. The response is paginated with a default limit of 100 rules per page."
},
{
"info": {
"name": "Create A New Transformation Rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/transformationRules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new transformation rule."
},
{
"info": {
"name": "Get A Transformation Rule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/transformationRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of transformation rule to return."
}
]
},
"docs": "Get a transformation rule with the given identifier."
},
{
"info": {
"name": "Update A Transformation Rule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/transformationRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the transformation rule to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing transformation rule. All properties specified in the request are replaced. Missing properties will remain the same."
},
{
"info": {
"name": "Delete A Transformation Rule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/transformationRules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the transformation rule to delete."
}
]
},
"docs": "Delete a transformation rule with the given identifier."
}
]
},
{
"info": {
"name": "accountManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get The Owner Of An Account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/account/accountOwner"
},
"docs": "Returns the user identifier of the account owner."
},
{
"info": {
"name": "Get Overview Of The Account Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/account/status"
},
"docs": "Get information related to the account's plan, pricing model, expiration and payment status."
},
{
"info": {
"name": "Get The Configured Subdomain.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/account/subdomain"
},
"docs": "Get the configured subdomain."
},
{
"info": {
"name": "Create Account Subdomain.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/account/subdomain",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a subdomain. Only the Account Owner can create a subdomain."
},
{
"info": {
"name": "Update Account Subdomain.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/account/subdomain",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a subdomain. Only the Account Owner can update the subdomain."
},
{
"info": {
"name": "Delete The Configured Subdomain.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/account/subdomain"
},
"docs": "Delete the configured subdomain."
},
{
"info": {
"name": "Recover Subdomains For A User.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/account/subdomain/recover",
"params": [
{
"name": "email",
"value": "",
"type": "query",
"description": "Email address of the user to get subdomain information."
}
]
},
"docs": "Send an email with the subdomain information for a user with the given email address."
},
{
"info": {
"name": "Export Credits Usage Details As CSV.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/account/usage/report",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Export the credit usage details as csv for the specific period of time given as input in the form of a start and end date with a specific grouping according to `day`, `week`, `month`, Note that this API will work only for credits plan customers."
},
{
"info": {
"name": "Get Report Generation Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/account/usage/report/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "Job Id for the report to be exported."
}
]
},
"docs": "Get the report download URL and status using Job Id."
},
{
"info": {
"name": "Get Usage Forecast With Respect To Last Number Of Days Specified.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/account/usageForecast",
"params": [
{
"name": "numberOfDays",
"value": "",
"type": "query",
"description": "Number of days to use for calculating average usage and forecast."
}
]
},
"docs": "Get usage forecast with respect to last number of days specified. If nothing is provided for last number of days, the average of term period will be taken to do the forecast."
},
{
"info": {
"name": "Get The Pending Plan Update Request, If Any.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/plan/pendingUpdateRequest"
},
"docs": "Get the pending plan update request which will be applicable from next billing cycle."
},
{
"info": {
"name": "Delete The Pending Plan Update Request, If Any.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/plan/pendingUpdateRequest"
},
"docs": "Delete the pending plan update request which would be applicable from next billing cycle."
}
]
},
{
"info": {
"name": "orgsManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Usages For Child Orgs.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/organizations/usages",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get the credits usage details of the child orgs for a parent."
}
]
},
{
"info": {
"name": "metricsSearchesManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Save A Metrics Search.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/metricsSearches",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Saves a metrics search in the content library. Metrics search consists of one or more queries, a time range, a quantization period and a set of chart properties like line width."
},
{
"info": {
"name": "Get A Metrics Search.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/metricsSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the metrics search."
}
]
},
"docs": "Returns a metrics search with the specified identifier."
},
{
"info": {
"name": "Updates A Metrics Search.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/metricsSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the metrics search."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates a metrics search with the specified identifier. Partial updates are not supported, you must provide values for all fields."
},
{
"info": {
"name": "Deletes A Metrics Search.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/metricsSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the metrics search."
}
]
},
"docs": "Deletes a metrics search from the content library."
}
]
},
{
"info": {
"name": "tokensLibraryManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Tokens.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tokens"
},
"docs": "Get a list of all tokens in the token library."
},
{
"info": {
"name": "Create A Token.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/tokens",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a token in the token library."
},
{
"info": {
"name": "Get A Token.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tokens/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the token to return."
}
]
},
"docs": "Get a token with the given identifier in the token library."
},
{
"info": {
"name": "Update A Token.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/tokens/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the token to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a token with the given identifier in the token library."
},
{
"info": {
"name": "Delete A Token.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/tokens/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the token to delete."
}
]
},
"docs": "Delete a token with the given identifier in the token library."
}
]
},
{
"info": {
"name": "accessKeyManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Access Keys.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/accessKeys",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of access keys returned in the response. The number of access keys returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "List all access keys in your account."
},
{
"info": {
"name": "Create An Access Key.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/accessKeys",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new access ID and key pair. The new access key can be used from the domains specified in corsHeaders field. Whether Sumo Logic accepts or rejects an API request depends on whether it contains an ORIGIN header and the entries in the allowlist. Sumo Logic will reject:\n 1. Requests with an ORIGIN header but the allowlist is empty.\n 2. Requests with an ORIGIN header that don't match any entry in the allowlist."
},
{
"info": {
"name": "List Personal Keys.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/accessKeys/personal"
},
"docs": "List all access keys that belong to your user."
},
{
"info": {
"name": "Get All Scopes.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/accessKeys/scopes"
},
"docs": "Get a list of all of the scopes that can be added to an access key."
},
{
"info": {
"name": "Update An Access Key.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/accessKeys/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The accessId of the access key to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of existing accessKey by accessId. It can be used to enable or disable the access key and to update the corsHeaders list."
},
{
"info": {
"name": "Delete An Access Key.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/accessKeys/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The accessId of the access key to delete."
}
]
},
"docs": "Deletes the access key with the given accessId."
},
{
"info": {
"name": "Rotate The Access Key Secret",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/accessKeys/:id/rotate",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The accessId of the access key to rotate the secret for."
}
]
},
"docs": "Generates a new secret for the access key that is passed in the call, keeping the same access ID."
}
]
},
{
"info": {
"name": "samlConfigurationManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of SAML Configurations.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/saml/identityProviders"
},
"docs": "Get a list of all SAML configurations in the organization."
},
{
"info": {
"name": "Create A New SAML Configuration.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/saml/identityProviders",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new SAML configuration in the organization."
},
{
"info": {
"name": "Update A SAML Configuration.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/saml/identityProviders/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the SAML configuration to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing SAML configuration in the organization."
},
{
"info": {
"name": "Delete A SAML Configuration.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/saml/identityProviders/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the SAML configuration to delete."
}
]
},
"docs": "Delete a SAML configuration with the given identifier from the organization."
},
{
"info": {
"name": "Get List Of Allowlisted Users.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/saml/allowlistedUsers"
},
"docs": "Get a list of allowlisted users."
},
{
"info": {
"name": "Allowlist A User.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/saml/allowlistedUsers/:userId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "Identifier of the user."
}
]
},
"docs": "Allowlist a user from SAML lockdown allowing them to sign in using a password in addition to SAML."
},
{
"info": {
"name": "Remove An Allowlisted User.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/saml/allowlistedUsers/:userId",
"params": [
{
"name": "userId",
"value": "",
"type": "path",
"description": "Identifier of user that will no longer be allowlisted from SAML Lockdown."
}
]
},
"docs": "Remove an allowlisted user requiring them to sign in using SAML."
},
{
"info": {
"name": "Require SAML For Sign-in.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/saml/lockdown/enable"
},
"docs": "Enabling SAML lockdown requires users to sign in using SAML preventing them from logging in with an email and password."
},
{
"info": {
"name": "Disable SAML Lockdown.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/saml/lockdown/disable"
},
"docs": "Disable SAML lockdown for the organization."
},
{
"info": {
"name": "Get SAML Configuration Metadata XML.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/saml/identityProviders/:id/metadata",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the SAML configuration for which metadata should be returned."
}
]
},
"docs": "Get metadata XML for a specific SAML configuration within the organization."
}
]
},
{
"info": {
"name": "serviceAllowlistManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Allowlisted CIDRs/IP Addresses.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/serviceAllowlist/addresses"
},
"docs": "Get a list of all allowlisted CIDR notations and/or IP addresses for the organization."
},
{
"info": {
"name": "Allowlist CIDRs/IP Addresses.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/serviceAllowlist/addresses/add",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Add CIDR notations and/or IP addresses to the allowlist of the organization if not already there. When service allowlisting functionality is enabled, CIDRs/IP addresses that are allowlisted will have access to Sumo Logic and/or content sharing."
},
{
"info": {
"name": "Remove Allowlisted CIDRs/IP Addresses.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/serviceAllowlist/addresses/remove",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Remove allowlisted CIDR notations and/or IP addresses from the organization. Removed CIDRs/IPs will immediately lose access to Sumo Logic and content sharing."
},
{
"info": {
"name": "Enable Service Allowlisting.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/serviceAllowlist/enable",
"params": [
{
"name": "allowlistType",
"value": "",
"type": "query",
"description": "The type of allowlisting to be enabled. It can be one of: `Login`, `Content`, or `Both`."
}
]
},
"docs": "Enable service allowlisting functionality for the organization. The service allowlisting can be for 1. Login: If enabled, access to Sumo Logic is granted only to CIDRs/IP addresses that are allowlisted. 2. Content: If enabled, dashboards can be shared with users connecting from CIDRs/IP addresses that are allowlisted without logging in."
},
{
"info": {
"name": "Disable Service Allowlisting.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/serviceAllowlist/disable",
"params": [
{
"name": "allowlistType",
"value": "",
"type": "query",
"description": "The type of allowlisting to be disabled. It can be one of: `Login`, `Content`, or `Both`."
}
]
},
"docs": "Disable service allowlisting functionality for login/API authentication or content sharing for the organization."
},
{
"info": {
"name": "Get The Allowlisting Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/serviceAllowlist/status"
},
"docs": "Get the status of the service allowlisting functionality for login/API authentication or content sharing for the organization."
}
]
},
{
"info": {
"name": "policiesManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Audit Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/audit"
},
"docs": "Get the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index)"
},
{
"info": {
"name": "Set Audit Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/audit",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the Audit policy. This policy specifies whether audit records for your account are enabled. You can access details about reported account events in the Sumo Logic Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Audit-Index)"
},
{
"info": {
"name": "Get Search Audit Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/searchAudit"
},
"docs": "Get the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index)"
},
{
"info": {
"name": "Set Search Audit Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/searchAudit",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the Search Audit policy. This policy specifies whether search records for your account are enabled. You can access details about your account's search capacity, queries run by users from the Sumo Search Audit Index. [Learn More](https://help.sumologic.com/Manage/Security/Search_Audit_Index)"
},
{
"info": {
"name": "Get Share Dashboards Outside Organization Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/shareDashboardsOutsideOrganization"
},
"docs": "Get the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org)"
},
{
"info": {
"name": "Set Share Dashboards Outside Organization Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/shareDashboardsOutsideOrganization",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the Share Dashboards Outside Organization policy. This policy allows users to share the dashboard with view only privileges outside of the organization (capability must be enabled from the Roles page). Disabling this policy will disable all dashboards that have been shared outside of the organization. [Learn More](https://help.sumologic.com/Visualizations-and-Alerts/Dashboards/Share_Dashboards/Share_a_Dashboard_Outside_Your_Org)"
},
{
"info": {
"name": "Get Data Access Level Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/dataAccessLevel"
},
"docs": "Get the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards)"
},
{
"info": {
"name": "Set Data Access Level Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/dataAccessLevel",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the Data Access Level policy. When enabled, this policy sets the default data access level for all newly created dashboards to the viewer’s role access filter. Otherwise, newly created dashboards will default to the sharer’s role access filter and might display data that viewers’ roles don’t allow them to view. [Learn More](https://help.sumologic.com/Manage/Security/Data_Access_Level_for_Shared_Dashboards)"
},
{
"info": {
"name": "Get User Concurrent Sessions Limit Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/userConcurrentSessionsLimit"
},
"docs": "Get the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions)"
},
{
"info": {
"name": "Set User Concurrent Sessions Limit Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/userConcurrentSessionsLimit",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the User Concurrent Sessions Limit policy. When enabled, the number of concurrent sessions a user may have is limited to the value entered. If a user exceeds the allowed number of sessions, the user's oldest session will be logged out to accommodate the new one. Disabling this policy means a user may have an unlimited number of concurrent sessions. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Limit_for_User_Concurrent_Sessions)"
},
{
"info": {
"name": "Get Max User Session Timeout Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/maxUserSessionTimeout"
},
"docs": "Get the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout)"
},
{
"info": {
"name": "Set Max User Session Timeout Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/maxUserSessionTimeout",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the Max User Session Timeout policy. When enabled, this policy sets the maximum web session timeout users are able to configure within their user preferences. Users preferences will be updated to match this value only if their current preference is set to a higher value. [Learn More](https://help.sumologic.com/Manage/Security/Set_a_Maximum_Web_Session_Timeout)"
},
{
"info": {
"name": "Get Access Key Lifetime Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/accessKeysLifetime"
},
"docs": "Get access key lifetime policy. This policy defines the maximum time an access key has once it has been created or rotated before it must be rotated. Otherwise, it will no longer be able to be used. The value 0 represents that the access keys will never expire and the time specified can be configured by the organization."
},
{
"info": {
"name": "Set Access Keys Lifetime Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/accessKeysLifetime",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sets the access keys lifetime policy. By setting this policy, the time an access key has to live before it is expired or must be rotated is defined based on the period (default = never) configured for the organization. Setting the value to 0 would represent that the access keys never expire."
},
{
"info": {
"name": "Get Data Deletion Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/policies/dataDeletion"
},
"docs": "Get the Data Deletion policy. This policy specifies whether users are allowed to delete data from Sumo Logic. Disabling this policy prevents users from deleting log data. [Learn More](https://help.sumologic.com/Manage/Security/Data_Deletion)"
},
{
"info": {
"name": "Set Data Deletion Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/policies/dataDeletion",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set the Data Deletion policy. This policy specifies whether users are allowed to delete data from Sumo Logic. Disabling this policy prevents users from deleting log data. [Learn More](https://help.sumologic.com/Manage/Security/Data_Deletion)"
}
]
},
{
"info": {
"name": "healthEvents",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Health Events.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/healthEvents",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of health events returned in the response. The number of health events returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of all the unresolved health events in your account."
},
{
"info": {
"name": "Health Events For Specific Resources.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/healthEvents/resources",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of health events returned in the response. The number of health events returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get a list of all the unresolved events in your account that belong to the supplied resource identifiers."
}
]
},
{
"info": {
"name": "archiveManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Ingestion Jobs For An Archive Source.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/archive/:sourceId/jobs",
"params": [
{
"name": "sourceId",
"value": "",
"type": "path",
"description": "The identifier of an Archive Source."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of jobs returned in the response. The number of jobs returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of all the ingestion jobs created on an Archive Source. The response is paginated with a default limit of 10 jobs per page."
},
{
"info": {
"name": "Create An Ingestion Job.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/archive/:sourceId/jobs",
"params": [
{
"name": "sourceId",
"value": "",
"type": "path",
"description": "The identifier of the Archive Source for which the job is to be added."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create an ingestion job to pull data from your S3 bucket."
},
{
"info": {
"name": "Delete An Ingestion Job.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/archive/:sourceId/jobs/:id",
"params": [
{
"name": "sourceId",
"value": "",
"type": "path",
"description": "The identifier of the Archive Source."
},
{
"name": "id",
"value": "",
"type": "path",
"description": "The identifier of the ingestion job to delete."
}
]
},
"docs": "Delete an ingestion job with the given identifier from the organization. The delete operation is only possible for jobs with a Succeeded or Failed status."
},
{
"info": {
"name": "List Ingestion Jobs For All Archive Sources.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/archive/jobs/count"
},
"docs": "Get a list of all Archive Sources with the count and status of ingestion jobs."
}
]
},
{
"info": {
"name": "logSearchesEstimatedUsage",
"type": "folder"
},
"items": [
{
"info": {
"name": "Gets Estimated Usage Details.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logSearches/estimatedUsage",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Gets the estimated volume of data that would be scanned for a given log search in the Infrequent data tier.\n"
},
{
"info": {
"name": "Gets Tier Wise Estimated Usage Details.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logSearches/estimatedUsageByTier",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Gets the estimated volume of data that would be scanned for a given log search per data tier.\n"
},
{
"info": {
"name": "Gets Estimated Usage Details Per Metering Type.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logSearches/estimatedUsageByMeteringType",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Gets the estimated volume of data, per metering type, that would be scanned for running a given log search for a given timerange.\n"
},
{
"info": {
"name": "Gets Estimated Usage Details Per View.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/logSearches/estimatedUsageByView",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Gets the estimated volume of data, per view, that would be scanned for running a given log search for a given timerange.\n"
}
]
},
{
"info": {
"name": "dashboardManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Dashboards.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/dashboards",
"params": [
{
"name": "limit",
"value": "50",
"type": "query",
"description": "Limit the number of dashboard returned in the response. The number of dashboards returned may be less than the `limit`."
},
{
"name": "token",
"value": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "mode",
"value": "createdByUser",
"type": "query",
"description": "whether to list all viewable dashboards under the folders"
}
]
},
"docs": "List all dashboards under the Personal folder created by the user or under folders viewable by user."
},
{
"info": {
"name": "Create A New Dashboard.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/dashboards",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new dashboard."
},
{
"info": {
"name": "Get A Dashboard.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/dashboards/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "UUID of the dashboard to return."
}
]
},
"docs": "Get a dashboard by the given identifier."
},
{
"info": {
"name": "Update A Dashboard.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/dashboards/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the dashboard to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a dashboard by the given identifier."
},
{
"info": {
"name": "Delete A Dashboard.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/dashboards/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the dashboard to delete."
}
]
},
"docs": "Delete a dashboard by the given identifier."
},
{
"info": {
"name": "Start A Report Job",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/dashboards/reportJobs",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedule an asynchronous job to generate a report from a template. All items in the template will be included unless specified. See template section for more details on individual templates. Reports can be generated in Pdf or Png format and exported in various methods (ex. direct download). You will get back an asynchronous job identifier on success. Use the [getAsyncReportGenerationStatus](#operation/getAsyncExportStatus) endpoint and the job identifier you got back in the response to track the"
},
{
"info": {
"name": "Get Report Generation Job Status",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/dashboards/reportJobs/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous report generation job."
}
]
},
"docs": "Get the status of an asynchronous report generation request for the given job identifier. On success, use the [getReportGenerationResult](#operation/getAsyncReportGenerationResult) endpoint to get the result of the report generation job."
},
{
"info": {
"name": "Get Report Generation Job Result",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/dashboards/reportJobs/:jobId/result",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous report generation job."
}
]
},
"docs": "Get the result of an asynchronous report generation request for the given job identifier."
},
{
"info": {
"name": "Migrate Legacy Dashboards To Dashboards(New)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/dashboards/migrate",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedule an asynchronous job to migrate a list of legacy Dashboards to Dashboard(New). Once migration is finished, the migrated dashboards will be in the same folder as the corresponding legacy Dashboard.\nNote: This feature is in beta and may not support all existing features of legacy dashboards.\n"
},
{
"info": {
"name": "Preview Of Migrating Legacy Dashboards To Dashboards(New)",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/dashboards/migrate/preview",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Get a preview of migrating Legacy Dashboards to Dashboard(New)"
},
{
"info": {
"name": "Get Dashboard Migration Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/dashboards/migrate/:jobId/status",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Dashboard Migration job."
}
]
},
"docs": "Get the status of an asynchronous Dashboard Migration job for the given job identifier. If job succeeds, use Dashboard Migration Result endpoint to see results of the migration."
},
{
"info": {
"name": "Get Dashboard Migration Result.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/dashboards/migrate/:jobId/result",
"params": [
{
"name": "jobId",
"value": "",
"type": "path",
"description": "The identifier of the asynchronous Dashboard Migration job."
}
]
},
"docs": "Get the result of an asynchronous Dashboard Migration request for the given job identifier."
},
{
"info": {
"name": "List All Dashboard Report Schedules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dashboards/reportSchedules",
"params": [
{
"name": "dashboardId",
"value": "",
"type": "query",
"description": "UUID of the dashboard that the report shedules are associated with."
},
{
"name": "limit",
"value": "50",
"type": "query",
"description": "Limit the number of dashboard report schedules returned in the response. The number of dashboard report schedules returned may be less than the `limit`."
},
{
"name": "token",
"value": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "List all dashboard report schedules created by the user."
},
{
"info": {
"name": "Schedule Dashboard Report",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/dashboards/reportSchedules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Schedule dashboard report to send at a specific date and time. The report should be sent as attachment or downloadable URL in one of the following notification types: 'Email', 'AWSLambda', 'AzureFunctions', 'Datadog', 'HipChat', 'Jira', 'NewRelic', 'Opsgenie', 'PagerDuty', 'Slack', 'MicrosoftTeams', 'ServiceNow', 'SumoCloudSOAR' and 'Webhook'."
},
{
"info": {
"name": "Get Dashboard Report Schedule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/dashboards/reportSchedules/:scheduleId",
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "Identifier of the dashboard report schedule to return."
}
]
},
"docs": "Get the schedule of a scheduled dashboard report by the given identifier."
},
{
"info": {
"name": "Update Dashboard Report Schedule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/dashboards/reportSchedules/:scheduleId",
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "identifier of the dashboard report schedule to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the schedule of a scheduled dashboard report by the given identifier."
},
{
"info": {
"name": "Delete Dashboard Report Schedule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/dashboards/reportSchedules/:scheduleId",
"params": [
{
"name": "scheduleId",
"value": "",
"type": "path",
"description": "UUID of the dashboard report schedule to delete."
}
]
},
"docs": "Delete the schedule of a scheduled dashboard report by the given identifier. The scheduled dashboard report will no longer be generated and sent."
}
]
},
{
"info": {
"name": "metricsSearchesManagementV2",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Metrics Search Pages.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/metricsSearches",
"params": [
{
"name": "limit",
"value": "50",
"type": "query",
"description": "Limit the number of metric searches returned in the response. The number of metric searches returned may be less than the `limit`."
},
{
"name": "token",
"value": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "mode",
"value": "createdByUser",
"type": "query",
"description": "whether to list all viewable metric searches under the folders"
}
]
},
"docs": "List all metrics search pages under the Personal folder created by the user or under folders viewable by user."
},
{
"info": {
"name": "Create A New Metrics Search Page.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/metricsSearches",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new metrics search page."
},
{
"info": {
"name": "Get A Metrics Search Page.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/metricsSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the metrics search page to return."
}
]
},
"docs": "Get a metrics search page by the given identifier."
},
{
"info": {
"name": "Update A Metrics Search Page.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/metricsSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the metrics search page to return."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a metrics search page by the given identifier."
},
{
"info": {
"name": "Delete A Metrics Search Page.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/metricsSearches/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the metrics search page to delete."
}
]
},
"docs": "Delete metrics search page by the given identifier."
}
]
},
{
"info": {
"name": "monitorsLibraryManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Usage Info Of Monitors.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/usageInfo"
},
"docs": "Get the current number and the allowed number of log and metrics monitors."
},
{
"info": {
"name": "Disable Monitors.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/monitors/disable",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
}
]
},
"docs": "Bulk disable monitors by the given identifiers."
},
{
"info": {
"name": "List All Playbooks.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/playbooks",
"params": [
{
"name": "playbookType",
"value": "CSE",
"type": "query",
"description": "A string value for playbook type."
}
]
},
"docs": "List all playbooks available to run."
},
{
"info": {
"name": "Get Playbook Details.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/playbooksDetails",
"params": [
{
"name": "ids",
"value": "649074b5b3d402d6e80b0d1d,649074b7b3d402d6e80b0da1,649074b6b3d402d6e80b0d75",
"type": "query",
"description": "A comma-separated list of playbook identifiers."
}
]
},
"docs": "Get the details of the playbooks with the specified identifiers."
},
{
"info": {
"name": "Bulk Read A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
},
{
"name": "skipChildren",
"value": "",
"type": "query",
"description": "a boolean parameter to control skipping fetching children of requested folder(s)"
}
]
},
"docs": "Bulk read a monitor or folder by the given identifiers from the monitors library."
},
{
"info": {
"name": "Create A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/monitors",
"params": [
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder in which to create the monitor or folder."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a monitor or folder in the monitors library."
},
{
"info": {
"name": "Bulk Delete A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/monitors",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
}
]
},
"docs": "Bulk delete a monitor or folder by the given identifiers in the monitors library."
},
{
"info": {
"name": "Get The Root Monitors Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/root"
},
"docs": "Get the root folder in the monitors library."
},
{
"info": {
"name": "Read A Monitor Or Folder By Its Path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/path",
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "The path of the monitor or folder."
}
]
},
"docs": "Read a monitor or folder by its path in the monitors library structure."
},
{
"info": {
"name": "Search For A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/search",
"params": [
{
"name": "query",
"value": "createdBy:000000000000968B Test",
"type": "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`"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "Maximum number of items you want in the response."
},
{
"name": "offset",
"value": "5",
"type": "query",
"description": "The position or row from where to start the search operation."
},
{
"name": "skipChildren",
"value": "",
"type": "query",
"description": "a boolean parameter to control skipping fetching children of requested folder(s)"
}
]
},
"docs": "Search for a monitor or folder in the monitors library structure."
},
{
"info": {
"name": "Get A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to read."
}
]
},
"docs": "Get a monitor or folder from the monitors library."
},
{
"info": {
"name": "Update A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "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."
},
{
"info": {
"name": "Delete A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to delete."
}
]
},
"docs": "Delete a monitor or folder from the monitors library."
},
{
"info": {
"name": "Get The Path Of A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id/path",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder."
}
]
},
"docs": "Get the full path of the monitor or folder in the monitors library."
},
{
"info": {
"name": "Move A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id/move",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to move."
},
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder to move the monitor or folder to."
}
]
},
"docs": "Move a monitor or folder to a different location in the monitors library."
},
{
"info": {
"name": "Copy A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id/copy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to copy."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Copy a monitor or folder in the monitors library."
},
{
"info": {
"name": "Export A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id/export",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to export."
}
]
},
"docs": "Export a monitor or folder. If the given identifier is a folder, everything under the folder is exported recursively with folder as the root."
},
{
"info": {
"name": "Import A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/monitors/:parentId/import",
"params": [
{
"name": "parentId",
"value": "",
"type": "path",
"description": "Identifier of the parent folder in which to import the monitor or folder."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import a monitor or folder."
},
{
"info": {
"name": "List Explicit Permissions On Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id/permissions",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to list permissions."
}
]
},
"docs": "List explicit permissions on monitor or folder in the monitors library."
},
{
"info": {
"name": "Set Permissions On Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/monitors/permissions/set",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Set permissions on monitor or folder in the monitors library."
},
{
"info": {
"name": "Revoke All Permissions On Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/monitors/permissions/revoke",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Revoke all permissions on monitor or folder in the monitors library."
},
{
"info": {
"name": "List Permission Summaries For A Monitor Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/monitors/:id/permissionSummariesBySubjects",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the monitor or folder to list permissions."
}
]
},
"docs": "List permission summary meta(s) grouped by subjects on monitor or folder in the monitors library."
}
]
},
{
"info": {
"name": "slosLibraryManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Bulk Fetch SLI Values, Error Budget Remaining And SLI Computation Status For The Current Compliance Period.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/sli",
"params": [
{
"name": "ids",
"value": "000000000000000A,000000000000000B",
"type": "query",
"description": "The identifiers of the SLOs."
}
]
},
"docs": "Bulk fetch SLI values, error budget remaining and SLI computation status for the current compliance period."
},
{
"info": {
"name": "Usage Info Of SLOs.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/usageInfo"
},
"docs": "Get the current number and the allowed number of log and metrics SLOs."
},
{
"info": {
"name": "Bulk Read A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
},
{
"name": "skipChildren",
"value": "",
"type": "query",
"description": "a boolean parameter to control skipping fetching children of requested folder(s)"
}
]
},
"docs": "Bulk read a slo or folder by the given identifiers from the slos library."
},
{
"info": {
"name": "Create A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/slos",
"params": [
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder in which to create the slo or folder."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a slo or folder in the slos library."
},
{
"info": {
"name": "Bulk Delete A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/slos",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
}
]
},
"docs": "Bulk delete a slo or folder by the given identifiers in the slos library."
},
{
"info": {
"name": "Get The Root Slos Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/root"
},
"docs": "Get the root folder in the slos library."
},
{
"info": {
"name": "Read A Slo Or Folder By Its Path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/path",
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "The path of the slo or folder."
}
]
},
"docs": "Read a slo or folder by its path in the slos library structure."
},
{
"info": {
"name": "Search For A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/search",
"params": [
{
"name": "query",
"value": "createdBy:000000000000968B Test",
"type": "query",
"description": "The search query to find slo 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\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`"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "Maximum number of items you want in the response."
},
{
"name": "offset",
"value": "5",
"type": "query",
"description": "The position or row from where to start the search operation."
},
{
"name": "skipChildren",
"value": "",
"type": "query",
"description": "a boolean parameter to control skipping fetching children of requested folder(s)"
}
]
},
"docs": "Search for a slo or folder in the slos library structure."
},
{
"info": {
"name": "Get A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder to read."
}
]
},
"docs": "Get a slo or folder from the slos library."
},
{
"info": {
"name": "Update A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/slos/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a slo or folder in the slos library."
},
{
"info": {
"name": "Delete A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/slos/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder to delete."
}
]
},
"docs": "Delete a slo or folder from the slos library."
},
{
"info": {
"name": "Get The Path Of A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/:id/path",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder."
}
]
},
"docs": "Get the full path of the slo or folder in the slos library."
},
{
"info": {
"name": "Move A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/slos/:id/move",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder to move."
},
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder to move the slo or folder to."
}
]
},
"docs": "Move a slo or folder to a different location in the slos library."
},
{
"info": {
"name": "Copy A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/slos/:id/copy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder to copy."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Copy a slo or folder in the slos library."
},
{
"info": {
"name": "Export A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/slos/:id/export",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the slo or folder to export."
}
]
},
"docs": "Export a slo or folder. If the given identifier is a folder, everything under the folder is exported recursively with folder as the root."
},
{
"info": {
"name": "Import A Slo Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/slos/:parentId/import",
"params": [
{
"name": "parentId",
"value": "",
"type": "path",
"description": "Identifier of the parent folder in which to import the slo or folder."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import a slo or folder."
}
]
},
{
"info": {
"name": "passwordPolicy",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get The Current Password Policy.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/passwordPolicy"
},
"docs": "Get the current password policy."
},
{
"info": {
"name": "Update Password Policy.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/passwordPolicy",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the current password policy."
}
]
},
{
"info": {
"name": "parsersLibraryManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get The Root Folder In The Library.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers/root"
},
"docs": "Get the root folder in the library.\n"
},
{
"info": {
"name": "Bulk Read Folders And Parsers.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "A comma-separated list of identifiers."
}
]
},
"docs": "Bulk read folders and parsers by the given identifiers from the library.\n"
},
{
"info": {
"name": "Create A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/parsers",
"params": [
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder in which to create the folder or parser."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a folder or parser.\n"
},
{
"info": {
"name": "Bulk Delete Folders And Parsers.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/parsers",
"params": [
{
"name": "ids",
"value": "",
"type": "query",
"description": "A comma-separated list of identifiers."
}
]
},
"docs": "Bulk delete folders and parsers by the given identifiers from the library.\n"
},
{
"info": {
"name": "Read A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser to read."
}
]
},
"docs": "Read a folder or parser.\n"
},
{
"info": {
"name": "Update A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a folder or parser.\n"
},
{
"info": {
"name": "Delete A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser to delete."
}
]
},
"docs": "Delete a folder or parser.\n"
},
{
"info": {
"name": "Get Full Path Of Folder Or Parser.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id/path",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser."
}
]
},
"docs": "Get full path of folder or parser.\n"
},
{
"info": {
"name": "Lock A Folder Or A Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id/lock",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the folder or parser that needs to be locked."
}
]
},
"docs": "Locking requires the `LockParsers` capability. When an object is locked, it can't be moved or deleted and only the local fields can be modified. Locking recursively locks all of the objects children.\n"
},
{
"info": {
"name": "Unlock A Folder Or A Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id/unlock",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the folder or parser that needs to be unlocked."
}
]
},
"docs": "Unlocking requires the `LockParsers` capability. It is only possible to unlock the highest locked object in a tree of locked objects. Unlocking recursively unlocks all of the objects children.\n"
},
{
"info": {
"name": "Move A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id/move",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser to move."
},
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder to move the folder or parser to."
}
]
},
"docs": "Move a folder or parser.\n"
},
{
"info": {
"name": "Copy A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id/copy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser to copy."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Copy a folder or parser.\n"
},
{
"info": {
"name": "Export A Folder Or Parser.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers/:id/export",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the folder or parser to export."
},
{
"name": "preserveLock",
"value": "",
"type": "query",
"description": "Set this to true if you want to export an object and preserve the locked status.\n"
}
]
},
"docs": "Export a folder or parser."
},
{
"info": {
"name": "Import A Folder Or Parser",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/parsers/:parentId/import",
"params": [
{
"name": "parentId",
"value": "",
"type": "path",
"description": "Identifier of the parent folder in which to import the folder or parser."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import a folder or parser\n"
},
{
"info": {
"name": "Read A Folder Or Parser By Its Path.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers/path",
"params": [
{
"name": "path",
"value": "",
"type": "query",
"description": "The path of the folder or parser."
}
]
},
"docs": "Read a folder or parser by its path.\n"
},
{
"info": {
"name": "Search For Folders Or Parsers.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/parsers/search",
"params": [
{
"name": "query",
"value": "",
"type": "query",
"description": "The search query to find folder or parsers. 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`.\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 `createdBy:000000000000968B createdAfter:1457997222 Test`"
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Maximum number of items you want in the response."
},
{
"name": "offset",
"value": "",
"type": "query",
"description": "The position or row from where to start the search operation."
}
]
},
"docs": "Search for a folder or parser in the cloud SIEM parsers library structure."
},
{
"info": {
"name": "Lock A Folder Or A Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/system/parsers/:id/lock",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the folder or parser that needs to be locked."
}
]
},
"docs": "Locking requires the `LockParsers` capability. When an object is locked, it can't be moved or deleted and only the local fields can be modified. Locking recursively locks all of the objects children.\n"
},
{
"info": {
"name": "Unlock A Folder Or A Parser.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/system/parsers/:id/unlock",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id of the folder or parser that needs to be unlocked."
}
]
},
"docs": "Unlocking requires the `LockParsers` capability. It is only possible to unlock the highest locked object in a tree of locked objects. Unlocking recursively unlocks all of the objects children.\n"
}
]
},
{
"info": {
"name": "serviceAccountManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A List Of Service Accounts.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts"
},
"docs": "Get a list of all service accounts in the organization."
},
{
"info": {
"name": "Create A New Service Account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a new service account in the organization."
},
{
"info": {
"name": "Get A Service Account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of service account to return."
}
]
},
"docs": "Get a service account with the given identifier from the organization."
},
{
"info": {
"name": "Update A Service Account.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the service account to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an existing service account in the organization."
},
{
"info": {
"name": "Delete A Service Account.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the service account to delete."
},
{
"name": "transferTo",
"value": "",
"type": "query",
"description": "Identifier of a user/service account to receive the transfer of content from the deleted service account.
**Note:** If `deleteContent` is not set to `true`, and no user identifier is specified in `transferTo`, content from the deleted service account is transferred to the executing user."
},
{
"name": "deleteContent",
"value": "",
"type": "query",
"description": "Whether to delete content from the deleted service account or not.
**Warning:** If `deleteContent` is set to `true`, all of the content for the service account being deleted is permanently deleted and cannot be recovered."
}
]
},
"docs": "Delete a service account with the given identifier from the organization and transfer its content to a user or a service account with the identifier specified in \"transferTo\"."
},
{
"info": {
"name": "List Access Keys For A Service Account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:serviceAccountId/accessKeys",
"params": [
{
"name": "serviceAccountId",
"value": "",
"type": "path",
"description": "Identifier of the service account."
}
]
},
"docs": "List all access keys of a service account."
},
{
"info": {
"name": "Create A New Access Key For A Service Account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:serviceAccountId/accessKeys",
"params": [
{
"name": "serviceAccountId",
"value": "",
"type": "path",
"description": "Identifier of the service account."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new access ID and key pair for a service account."
},
{
"info": {
"name": "Get An Access Key Of A Service Account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:serviceAccountId/accessKeys/:accessId",
"params": [
{
"name": "serviceAccountId",
"value": "",
"type": "path",
"description": "Identifier of the service account."
},
{
"name": "accessId",
"value": "",
"type": "path",
"description": "Identifier of an access key to return."
}
]
},
"docs": "Get an access key with the given identifier from the organization of a service account."
},
{
"info": {
"name": "Update An Access Key Of A Service Account.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:serviceAccountId/accessKeys/:accessId",
"params": [
{
"name": "serviceAccountId",
"value": "",
"type": "path",
"description": "Identifier of the service account."
},
{
"name": "accessId",
"value": "",
"type": "path",
"description": "The id of an access key to update of a service account."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates the properties of existing accessKey by Id of a service account."
},
{
"info": {
"name": "Delete An Access Key Of A Service Account.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/serviceAccounts/:serviceAccountId/accessKeys/:accessId",
"params": [
{
"name": "serviceAccountId",
"value": "",
"type": "path",
"description": "Identifier of the service account."
},
{
"name": "accessId",
"value": "",
"type": "path",
"description": "The Id of the access key to delete of a service account."
}
]
},
"docs": "Deletes the access key with the given Id of a service account."
}
]
},
{
"info": {
"name": "oauthManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get All Scopes.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/oauth/scopes"
},
"docs": "** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **\n\nGet a list of all of the scopes that can be added to an oauth client."
},
{
"info": {
"name": "List The OAuth Clients.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/oauth/clients",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of OAuth clients returned in the response. The number of OAuth clients returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "runAsId",
"value": "",
"type": "query",
"description": "Identifier of the service account that the OAuth Client runs as."
}
]
},
"docs": "** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **\n\nList all OAuth clients."
},
{
"info": {
"name": "Create A New OAuth Client.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/oauth/clients",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **\n\nCreates a new OAuth clientId and clientSecret."
},
{
"info": {
"name": "Get An OAuth Client.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/oauth/clients/:clientId",
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "Identifier of an OAuth client to return."
}
]
},
"docs": "** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **\n\nGet an OAuth client with the given identifier from the organization."
},
{
"info": {
"name": "Update An OAuth Client.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/oauth/clients/:clientId",
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The id of an OAuth client to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **\n\nUpdates the properties of existing OAuth client by Id."
},
{
"info": {
"name": "Delete An OAuth Client.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/oauth/clients/:clientId",
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The Id of the OAuth client to delete."
}
]
},
"docs": "** Only available to Beta customers. During Beta endpoints are subject to backwards incompatible changes. **\n\nDeletes the OAuth client with the given Id."
},
{
"info": {
"name": "Rotate The Oauth Client Secret",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/oauth/clients/:clientId/rotate",
"params": [
{
"name": "clientId",
"value": "",
"type": "path",
"description": "The ID of the oauth client to rotate the secret for."
}
]
},
"docs": "Generates a new secret for the oauth client that is passed in the call, keeping the same client ID."
},
{
"info": {
"name": "List OAuth Consents.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/oauth/consents",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of consents returned in the response."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results."
},
{
"name": "authorizedUser",
"value": "",
"type": "query",
"description": "Filter consents by the identifier of the user who authorized the consent."
},
{
"name": "clientId",
"value": "",
"type": "query",
"description": "Filter consents by the clientId of a registered OAuth client."
}
]
},
"docs": "Get a list of OAuth consents within the organization. Administrators can list all consents, while others can only list consents that they have authorized."
},
{
"info": {
"name": "Delete An OAuth Consent.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/oauth/consents/:consentId",
"params": [
{
"name": "consentId",
"value": "",
"type": "path",
"description": "The ID of the OAuth consent to delete."
}
]
},
"docs": "Deletes the OAuth consent with the given Id."
}
]
},
{
"info": {
"name": "scimUserManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List SCIM Users",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/scim/Users",
"params": [
{
"name": "startIndex",
"value": "",
"type": "query",
"description": "The index of the first result to return. Defaults to 1 if not specified, a value less than 1 SHALL be interpreted as 1"
},
{
"name": "count",
"value": "",
"type": "query",
"description": "The maximum number of results to return. Defaults to 100"
},
{
"name": "filter",
"value": "",
"type": "query",
"description": "Find user with the given email address"
},
{
"name": "sortOrder",
"value": "",
"type": "query",
"description": "The sort order. Use \"ascending\" or \"descending\""
},
{
"name": "sortBy",
"value": "",
"type": "query",
"description": "Sort the list of users by the `givenName`, `familyName`, or `emails` field"
}
]
},
"docs": "Retrieves a list of users in the SCIM system, with optional pagination"
},
{
"info": {
"name": "Create SCIM User",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/scim/Users",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new user in the SCIM system"
},
{
"info": {
"name": "Get A SCIM User",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/scim/Users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the SCIM user"
}
]
},
"docs": "Fetches the details of a SCIM user by their unique identifier"
},
{
"info": {
"name": "Update SCIM User",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/scim/Users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the SCIM user"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates an existing user's attributes in the SCIM system"
},
{
"info": {
"name": "Update SCIM User Attributes",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "https://api.au.sumologic.com/api/v1/scim/Users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the SCIM user"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates specific attributes of an existing user in the SCIM system"
},
{
"info": {
"name": "Delete SCIM User",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/scim/Users/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Unique identifier of the SCIM user to delete"
}
]
},
"docs": "Deletes a SCIM user by their unique identifier"
}
]
},
{
"info": {
"name": "metricsQuery",
"type": "folder"
},
"items": [
{
"info": {
"name": "Run Metrics Queries",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/metricsQueries",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Execute multiple metrics queries. Limits of this API are described in [Metrics Query Error Messages](https://help.sumologic.com/docs/metrics/metrics-queries/metric-query-error-messages/). For general information about Metrics Queries see [Metrics Queries](https://help.sumologic.com/docs/metrics/metrics-queries/)."
}
]
},
{
"info": {
"name": "traces",
"type": "folder"
},
"items": [
{
"info": {
"name": "Run A Trace Search Query Asynchronously.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/tracing/tracequery",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Execute a trace search query and get the id to fetch its status and results. Use the [Trace Query Status](#operation/getTraceQueryStatus) endpoint to check a query status. When the query has been completed, use the [Trace Query Result](#operation/getTraceQueryResult) endpoint to get the result of the asynchronous query."
},
{
"info": {
"name": "Cancel A Trace Search Query.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/tracing/tracequery/:queryId",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the query to cancel."
}
]
},
"docs": "Cancel a currently processed trace search query with the given id."
},
{
"info": {
"name": "Get A Trace Search Query Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/tracequery/:queryId/status",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the executed query."
}
]
},
"docs": "Get a status of a trace query with the given id. When the query has been completed, use the [Trace Query Result](#operation/getTraceQueryResult) endpoint to get the result of the asynchronous query."
},
{
"info": {
"name": "Get Results Of A Trace Search Query.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/tracequery/:queryId/rows/:rowId/traces",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the executed query."
},
{
"name": "rowId",
"value": "",
"type": "path",
"description": "Identifier of the query row."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit of the number of traces returned in the response."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of traces matching a query with the specified id. The response is paginated with a default limit of 100 traces per page."
},
{
"info": {
"name": "Get Trace Search Query Metrics.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/metrics"
},
"docs": "Get a list of available trace metrics that can be used in trace search queries."
},
{
"info": {
"name": "Get Filter Fields For Trace Search Queries.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/tracequery/fields"
},
"docs": "Get a list of available fields which can be used in trace search queries."
},
{
"info": {
"name": "Get Trace Search Query Filter Field Values.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/tracequery/fields/:field/values",
"params": [
{
"name": "field",
"value": "",
"type": "path",
"description": "Field identifier."
},
{
"name": "query",
"value": "",
"type": "query",
"description": "Search filter to apply on the values to be returned. Only values containing the search query term will be returned."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of results to fetch."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
},
{
"name": "fieldType",
"value": "",
"type": "query",
"description": "Indicates the kind of a field. Possible values: `SpanAttribute`, `SpanEventAttribute`."
}
]
},
"docs": "Get a list of available values for the given trace search query filter field. Not all fields support value listing. The response is paginated with a default limit of 10 values per page."
},
{
"info": {
"name": "Get Trace Details.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace to get the details."
}
]
},
"docs": "Get details of a trace with the given identifier."
},
{
"info": {
"name": "Check If The Trace Exists.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/exists",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace to check."
}
]
},
"docs": "Check if the trace with the given identifier exists."
},
{
"info": {
"name": "Get A List Of Trace Spans.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/spans",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace to get the spans."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of results to fetch."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of spans for the given trace. The response is paginated with a default limit of 100 spans per page."
},
{
"info": {
"name": "Get A List Of Events (without Their Attributes) Per Span For A Trace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/traceEvents",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace for which span events will be returned."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of spans with events returned by a single query."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Gets a list of the events (without their attributes) attached to each span in a given trace. The response is paginated with a default limit of 100 spans per page."
},
{
"info": {
"name": "Get A Critical Path Of A Trace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/criticalPath",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of results to fetch."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of span segments composing the critical path of the trace. A span segment represents the processing time that was consumed within the span itself and does not incorporate the processing time of its children. The critical path is the sequence of span segments that contribute to the total trace duration. An increase of the processing time of any segment from the critical path would result in an increase of the total trace processing time."
},
{
"info": {
"name": "Get A Critical Path Service Breakdown Of A Trace.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/criticalPath/breakdown/service",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace."
}
]
},
"docs": "Get a critical path breakdown by services of the spans contributing to the critical path of a trace with the given identifier."
},
{
"info": {
"name": "Get Span Details.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/spans/:spanId",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace the span belongs to."
},
{
"name": "spanId",
"value": "",
"type": "path",
"description": "Identifier of the span to get the details."
}
]
},
"docs": "Get details of a span with the given identifier."
},
{
"info": {
"name": "Get Span Billing Details.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/traces/:traceId/spans/:spanId/billingInfo",
"params": [
{
"name": "traceId",
"value": "",
"type": "path",
"description": "Identifier of the trace the span belongs to."
},
{
"name": "spanId",
"value": "",
"type": "path",
"description": "Identifier of the span to get the billing info."
}
]
},
"docs": "Get the billing information of the span."
}
]
},
{
"info": {
"name": "spanAnalytics",
"type": "folder"
},
"items": [
{
"info": {
"name": "Run A Span Analytics Query Asynchronously.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Execute a span analytics query and get the id to fetch its status and results. Use the [Span Query Status](#operation/getSpanQueryStatus) endpoint to check a query status. When the query has been completed, use the [Span Query Result](#operation/getSpanQueryResult) endpoint to get the result of the asynchronous query."
},
{
"info": {
"name": "Cancel A Span Analytics Query.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the query to cancel."
}
]
},
"docs": "Cancel a currently processed span search query with the given id."
},
{
"info": {
"name": "Get A Span Analytics Query Status.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId/status",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the executed query."
}
]
},
"docs": "Get a status of a span analytics query with the given id. When the query has been completed, use the [Span Query Result](#operation/getSpanQueryResult) endpoint to get the result of the asynchronous query."
},
{
"info": {
"name": "Pause A Span Analytics Query.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId/pause",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the query to pause."
}
]
},
"docs": "Pause a currently processed span search query with the given id."
},
{
"info": {
"name": "Resume A Span Analytics Query.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId/resume",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the query to resume."
}
]
},
"docs": "Resume a previously paused span search query with the given id."
},
{
"info": {
"name": "Get Results Of A Span Analytics Query.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId/rows/:rowId/spans",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the executed query."
},
{
"name": "rowId",
"value": "",
"type": "path",
"description": "Identifier of the query row."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit of the number of spans returned in the response."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of spans matching a query with the specified id. The response is paginated with a default limit of 100 spans per page."
},
{
"info": {
"name": "Get A List Of Facets Of A Span Analytics Query.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId/rows/:rowId/facets",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the executed query."
},
{
"name": "rowId",
"value": "",
"type": "path",
"description": "Identifier of the query row."
}
]
},
"docs": "Get a list of facets of a span analytics query with the specified id."
},
{
"info": {
"name": "Get Span Analytics Query Aggregated Results.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/:queryId/aggregates",
"params": [
{
"name": "queryId",
"value": "",
"type": "path",
"description": "Identifier of the executed query."
}
]
},
"docs": "Get span aggregation results for an aggregated span analytics query with the specified id. Only aggregated rows being part of the executed query will have matching results in the response of this endpoint."
},
{
"info": {
"name": "Get Filter Fields For Span Analytics Queries.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/fields"
},
"docs": "Get a list of available fields which can be used in span analytics queries."
},
{
"info": {
"name": "Get Span Analytics Query Filter Field Values.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/spanquery/fields/:field/values",
"params": [
{
"name": "field",
"value": "",
"type": "path",
"description": "Field identifier."
},
{
"name": "query",
"value": "",
"type": "query",
"description": "Search filter to apply on the values to be returned. Only values containing the search query term will be returned."
},
{
"name": "limit",
"value": "",
"type": "query",
"description": "The maximum number of results to fetch."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "Get a list of available values for the given span analytics query filter field. Not all fields support value listing. The response is paginated with a default limit of 10 field values per page."
}
]
},
{
"info": {
"name": "serviceMap",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get A Service Map.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/tracing/serviceMap"
},
"docs": "Run a search request to get a map of services and connections between them."
}
]
},
{
"info": {
"name": "threatIntelIngest",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Threat Intel Indicators DB Information",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/db"
},
"docs": "Get threat intel indicators DB information, such as storage utilization and indicator counts"
},
{
"info": {
"name": "Remove The Threat Intel Indicators DB",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/db"
},
"docs": "Removes the entire database and all indicators associated with this tenant"
},
{
"info": {
"name": "Get Threat Intel Indicators Store Retention Period In Terms Of Days.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/retentionPeriod"
},
"docs": "Get the threat intel indicators store retention period in terms of days."
},
{
"info": {
"name": "Set The Threat Intel Indicators Store Retention Period In Terms Of Days.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/retentionPeriod",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Sets the threat intel indicators store retention period in terms of days."
},
{
"info": {
"name": "Updates Source Properties",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/dataSource/:dataSourceName",
"params": [
{
"name": "dataSourceName",
"value": "",
"type": "path",
"description": "Source name"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Updates source properties"
}
]
},
{
"info": {
"name": "threatIntelIngestProducer",
"type": "folder"
},
"items": [
{
"info": {
"name": "Uploads Indicators In A Sumo Normalized Format.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/indicators/normalized",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Uploads a list indicators in a Sumo normalized format."
},
{
"info": {
"name": "Uploads Indicators In A STIX 2.x Json Format.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/indicators/stix",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Uploads a list indicators in in a STIX 2.x json format."
},
{
"info": {
"name": "Removes Indicators By Their IDS",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/threatIntel/datastore/indicators",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Removes indicators by specifying a list of indicator IDs"
}
]
},
{
"info": {
"name": "otCollectorManagementExternal",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Paginated List Of OT Collectors",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/otCollectors",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Given different filter, search and sort conditions, get list of otCollectors."
},
{
"info": {
"name": "Get OT Collector By ID.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/otCollectors/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the OT Collector to get."
}
]
},
"docs": "Get OT Collector by ID."
},
{
"info": {
"name": "Delete An OT Collector.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/otCollectors/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the OT Collector to delete."
}
]
},
"docs": "Delete an OT Collector with the given identifier."
},
{
"info": {
"name": "Get A Count Of OT Collectors.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/otCollectors/totalCount"
},
"docs": "Get total count of OT Collectors for a customer."
},
{
"info": {
"name": "Get OT Collectors By Name.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/otCollectors/otCollectorsByName",
"params": [
{
"name": "names",
"value": "",
"type": "query",
"description": "A required parameter that accepts a list of names for which we need to collect all metadata."
}
]
},
"docs": "provided list of names, get all OT Collectors with metadata."
},
{
"info": {
"name": "Delete All Offline OT Collectors",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/otCollectors/offline"
},
"docs": "Delete all offline OT Collectors for a given customer."
}
]
},
{
"info": {
"name": "sourceTemplateManagementExternal",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Source Templates.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates",
"params": [
{
"name": "showDisabled",
"value": "",
"type": "query",
"description": "A boolean parameter to get all, including disabled source templates."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Only return source template matching the given name (exact match)."
}
]
},
"docs": "Get a list of all source templates."
},
{
"info": {
"name": "Create Source Template.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create source template."
},
{
"info": {
"name": "Get A Source Template By Id.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to get."
}
]
},
"docs": "Get a source template with the given identifier."
},
{
"info": {
"name": "Update Source Template.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a source template with the given identifier."
},
{
"info": {
"name": "Delete A Source Template.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to delete."
}
]
},
"docs": "Delete a source template with the given identifier."
},
{
"info": {
"name": "Update Status Of Source Template",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates/:id/status",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the status (enable or disable) of a source template."
},
{
"info": {
"name": "Upgrade Source Template.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates/:id/upgrade",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to upgrade."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade a source template with the given identifier."
},
{
"info": {
"name": "Preview Source Template Linking Changes.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplates/getLinkedSourceTemplatesImpact",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Given the set of tags user wants to update, display the list of source templates that will be linked/unlinked to the otCollector."
},
{
"info": {
"name": "Return All Source Templates Of A Customer (deprecated).",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate",
"params": [
{
"name": "showDisabled",
"value": "",
"type": "query",
"description": "A boolean parameter to get all, including disabled source templates."
},
{
"name": "name",
"value": "",
"type": "query",
"description": "Only return source template matching the given name (exact match)."
}
]
},
"docs": "Get a list of source template.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use GET /v1/sourceTemplates instead.\n"
},
{
"info": {
"name": "Create Source Template (deprecated).",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create source template.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use POST /v1/sourceTemplates instead.\n"
},
{
"info": {
"name": "Get A Source Template By Id (deprecated).",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to get."
}
]
},
"docs": "Get a source template with the given identifier.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use GET /v1/sourceTemplates/{id} instead.\n"
},
{
"info": {
"name": "Update Source Template (deprecated).",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a source template with the given identifier.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use POST /v1/sourceTemplates/{id} instead.\n"
},
{
"info": {
"name": "Delete A Source Template (deprecated).",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to delete."
}
]
},
"docs": "Delete a source template with the given identifier.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use DELETE /v1/sourceTemplates/{id} instead.\n"
},
{
"info": {
"name": "Upgrade Source Template (deprecated).",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/upgrade/sourceTemplate/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to upgrade."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Upgrade a source template with the given identifier.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use POST /v1/sourceTemplates/{id}/upgrade instead.\n"
},
{
"info": {
"name": "Get Linked Source Templates Update Based On The Ot-collector Tags User Is Wants To Update.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate/getLinkedSourceTemplatesImpact",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Given the set of tags user wants to update, display the list of source templates that will be linked/unlinked to the otCollector."
},
{
"info": {
"name": "Update Status Of Source Template (deprecated)",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/sourceTemplate/:id/status",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the source template to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update the status (enable or disable) of a source template.\n\n**DEPRECATED**: This endpoint will be removed soon. Please use PUT /v1/sourceTemplates/{id}/status instead.\n"
}
]
},
{
"info": {
"name": "schemaBaseManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Schema Base Identities Grouped By Type And Sorted By Version.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/schemaIdentitiesGrouped"
},
"docs": "Get a summary of all available schema bases grouped by type and their versions sorted by latest."
}
]
},
{
"info": {
"name": "eventAnalytics",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get All Event Extraction Rules.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/eventExtractionRules"
},
"docs": "Get all event extraction rules."
},
{
"info": {
"name": "Create Event Extraction Rule.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/eventExtractionRules",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create event extraction rule."
},
{
"info": {
"name": "Get Event Extraction Rules Quota.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/eventExtractionRules/quota"
},
"docs": "Every customer can use a limited number of Event Extraction Rules. This endpoint allows learning about these limitations and remaining quota."
},
{
"info": {
"name": "Get An Event Extraction Rule.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/eventExtractionRules/:id",
"params": [
{
"name": "id",
"value": "000000000000000A",
"type": "path",
"description": "The identifier of the event extraction rule."
}
]
},
"docs": "Get an event extraction rule."
},
{
"info": {
"name": "Update An Event Extraction Rule.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/eventExtractionRules/:id",
"params": [
{
"name": "id",
"value": "000000000000000A",
"type": "path",
"description": "The identifier of the event extraction rule."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update an event extraction rule."
},
{
"info": {
"name": "Delete An Event Extraction Rule.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/eventExtractionRules/:id",
"params": [
{
"name": "id",
"value": "000000000000000A",
"type": "path",
"description": "The identifier of the event extraction rule."
}
]
},
"docs": "Delete an event extraction rule."
}
]
},
{
"info": {
"name": "budgetManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get Budgets",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/budgets",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of budgets returned in the response. The number of budgets returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results."
}
]
},
"docs": "Get budgets"
},
{
"info": {
"name": "Creates A Budget Definition",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/budgets",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a budget definition"
},
{
"info": {
"name": "Get Budget",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/budgets/:budgetId",
"params": [
{
"name": "budgetId",
"value": "",
"type": "path",
"description": "The id of the budget."
}
]
},
"docs": "Get budget"
},
{
"info": {
"name": "Update Budget",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/budgets/:budgetId",
"params": [
{
"name": "budgetId",
"value": "",
"type": "path",
"description": "The id of the budget."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update budget"
},
{
"info": {
"name": "Delete Budget",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/budgets/:budgetId",
"params": [
{
"name": "budgetId",
"value": "",
"type": "path",
"description": "The id of the budget."
}
]
},
"docs": "Delete budget"
},
{
"info": {
"name": "Get Budget Usages",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/budgets/usage",
"params": [
{
"name": "limit",
"value": "",
"type": "query",
"description": "Limit the number of budget usages returned in the response. The number of budget usages returned may be less than the `limit`."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results."
}
]
},
"docs": "Get budget usages"
},
{
"info": {
"name": "Get Budget Usage",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/budgets/:budgetId/usage",
"params": [
{
"name": "budgetId",
"value": "",
"type": "path",
"description": "The id of the budget."
}
]
},
"docs": "Get budget usage"
}
]
},
{
"info": {
"name": "macroManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "List All Macros.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/macros",
"params": [
{
"name": "limit",
"value": "50",
"type": "query",
"description": "Limit the number of macro returned in the response. The number of macros returned may be less than the `limit`. Default 50."
},
{
"name": "token",
"value": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc",
"type": "query",
"description": "Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. `token` is set to null when no more pages are left."
}
]
},
"docs": "List all viewable macros for the customer."
},
{
"info": {
"name": "Create A New Macro.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v2/macros",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Creates a new macro."
},
{
"info": {
"name": "Get A Macro.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v2/macros/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "UUID of the macro."
}
]
},
"docs": "Get a macro by the given identifier."
},
{
"info": {
"name": "Edit A Macro.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v2/macros/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "UUID of the macro to edit."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Edits an existing macro by id. Macro name is immutable."
},
{
"info": {
"name": "Delete A Macro.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v2/macros/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Id of macro to delete."
}
]
},
"docs": "Delete a macro by id."
}
]
},
{
"info": {
"name": "mutingSchedulesLibraryManagement",
"type": "folder"
},
"items": [
{
"info": {
"name": "Bulk Read A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
},
{
"name": "skipChildren",
"value": "",
"type": "query",
"description": "a boolean parameter to control skipping fetching children of requested folder(s)"
}
]
},
"docs": "Bulk read a mutingschedule or folder by the given identifiers from the mutingSchedules library."
},
{
"info": {
"name": "Create A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules",
"params": [
{
"name": "parentId",
"value": "",
"type": "query",
"description": "Identifier of the parent folder in which to create the mutingschedule or folder."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Create a mutingschedule or folder in the mutingSchedules library."
},
{
"info": {
"name": "Bulk Delete A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules",
"params": [
{
"name": "ids",
"value": "0000000000000001,0000000000000002,0000000000000003",
"type": "query",
"description": "A comma-separated list of identifiers."
}
]
},
"docs": "Bulk delete a mutingschedule or folder by the given identifiers in the mutingSchedules library."
},
{
"info": {
"name": "Get The Root MutingSchedules Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/root"
},
"docs": "Get the root folder in the mutingSchedules library."
},
{
"info": {
"name": "Search For A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/search",
"params": [
{
"name": "query",
"value": "createdBy:000000000000968B Test",
"type": "query",
"description": "The search query to find mutingschedule 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\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`"
},
{
"name": "limit",
"value": "10",
"type": "query",
"description": "Maximum number of items you want in the response."
},
{
"name": "offset",
"value": "5",
"type": "query",
"description": "The position or row from where to start the search operation."
},
{
"name": "skipChildren",
"value": "",
"type": "query",
"description": "a boolean parameter to control skipping fetching children of requested folder(s)"
}
]
},
"docs": "Search for a mutingschedule or folder in the mutingSchedules library structure."
},
{
"info": {
"name": "Get A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the mutingschedule or folder to read."
}
]
},
"docs": "Get a mutingschedule or folder from the mutingSchedules library."
},
{
"info": {
"name": "Update A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the mutingschedule or folder to update."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Update a mutingschedule or folder in the mutingSchedules library."
},
{
"info": {
"name": "Delete A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the mutingschedule or folder to delete."
}
]
},
"docs": "Delete a mutingschedule or folder from the mutingSchedules library."
},
{
"info": {
"name": "Get The Path Of A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:id/path",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the mutingschedule or folder."
}
]
},
"docs": "Get the full path of the mutingschedule or folder in the mutingSchedules library."
},
{
"info": {
"name": "Copy A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:id/copy",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the mutingschedule or folder to copy."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Copy a mutingschedule or folder in the mutingSchedules library."
},
{
"info": {
"name": "Export A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:id/export",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "Identifier of the mutingschedule or folder to export."
}
]
},
"docs": "Export a mutingschedule or folder. If the given identifier is a folder, everything under the folder is exported recursively with folder as the root."
},
{
"info": {
"name": "Import A Mutingschedule Or Folder.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.au.sumologic.com/api/v1/mutingSchedules/:parentId/import",
"params": [
{
"name": "parentId",
"value": "",
"type": "path",
"description": "Identifier of the parent folder in which to import the mutingschedule or folder."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Import a mutingschedule or folder."
}
]
}
],
"bundled": true
}