Sumo Logic contentManagement API
Content management API. You can export, import, delete and copy content in your organization’s Library. For more information, see [Library](https://help.sumologic.com/?cid=5173). You can perform the request as a Content Administrator by using the `isAdminMode` parameter. For more information, see [Admin Mode](https://help.sumologic.com/docs/manage/content-sharing/admin-mode). ### Example The following example uses API endpoints in the US1 deployment. Sumo Logic has several deployments that are assigned depending on the geographic location and the date an account is created. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011). The [Content Import API](#operation/beginAsyncImport) can be used to create or update a Search, Scheduled Search, or Dashboard. Here is an example creating a Scheduled Search: 1. Get the identifier of your `Personal` folder. ```bash curl -X GET -u ":" https://api.sumologic.com/api/v2/content/folders/personal ``` Find the identifier of your `Personal` folder in the response. ```json { ... "id": "0000000006A2E86F", :" -H "Content-Type: application/json" -d @search.json https://api.sumologic.com/api/v2/content/folders/0000000006A2E86F/import ``` The data file `search.json` in the above command has the following `SavedSearchWithScheduleSyncDefinition` object. ```json // file: search.json { "type": "SavedSearchWithScheduleSyncDefinition", "name": "demo-scheduled-search", "description": "Runs every hour with timerange of 15m and sends email notifications", "search": { "queryText": "\"error\" and \"warn\"", "defaultTimeRange": "-15m", "byReceiptTime": false, "viewName": "", "viewStartTime": null, "queryParameters": [] }, "searchSchedule": { "cronExpression": "0 0/15 * * * ? *", "displayableTimeRange": "-15m", "parseableTimeRange": { "from": { "relativeTime": "-15m", "type": "RelativeTimeRangeBoundary" }, "to": null, "type": "BeginBoundedTimeRange" }, "timeZone": "America/Los_Angeles", "threshold": null, "notification": { "taskType": "EmailSearchNotificationSyncDefinition", "toList": [ "ops@acme.org" ], "subjectTemplate": "Search Results: {{SearchName}}", "includeQuery": true, "includeResultSet": true, "includeHistogram": true, "includeCsvAttachment": false }, "muteErrorEmails": false, "scheduleType": "1Hour", "parameters": [] } } ``` The response of above request will have the job identifier that you can use to track the status of the import job. ```json { "id": "74DC17FA765C7443" } ``` 3. Use the job identifier from the import request to get the [status](#operation/getAsyncImportStatus) of the import job. ```bash curl -X GET -u ":" https://api.sumologic.com/api/v2/content/folders/0000000006A2E86F/import/74DC17FA765C7443/status ``` If you are importing a large item, you might have to wait for the import job to finish. The following is an example response from a completed job. ```json { "status": "Success", "statusMessage": null, "error": null } ```
Documentation
Specifications
Other Resources
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement contentManagement API
description: "# Getting Started\nWelcome to the Sumo Logic API reference. You can use these APIs to interact with the Sumo Logic platform. For information on Collector and Search Job APIs, see our [API home page](https://help.sumologic.com/docs/api).\n## API Endpoints\nSumo Logic has several deployments in different geographic locations. You'll need to use the Sumo Logic API endpoint corresponding to your geographic location. See the table below for the different API endpoints by deployment. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\n\n <table>\n <tr>\n <td> <strong>Deployment</strong> </td>\n <td> <strong>Endpoint</strong> </td>\n </tr>\n <tr>\n <td> AU </td>\n <td> https://api.au.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> CA </td>\n <td> https://api.ca.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> DE </td>\n <td> https://api.de.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> EU </td>\n <td> https://api.eu.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> FED </td>\n <td> https://api.fed.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> IN </td>\n <td> https://api.in.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> JP </td>\n <td> https://api.jp.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> KR </td>\n <td> https://api.kr.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US1 </td>\n <td> https://api.sumologic.com/api/ </td>\n </tr>\n <tr>\n <td> US2 </td>\n <td> https://api.us2.sumologic.com/api/ </td>\n </tr>\n </table>\n\n## Authentication\nSumo Logic supports the following options for API authentication:\n- Access ID and Access Key\n- Base64 encoded Access ID and Access Key\n\nSee [Access Keys](https://help.sumologic.com/docs/manage/security/access-keys) to generate an Access Key. Make sure to copy the key you create, because it is displayed only once.\nWhen you have an Access ID and Access Key you can execute requests such as the following:\n ```bash\n curl -u \"<accessId>:<accessKey>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\nWhere `deployment` is either `au`, `ca`, `de`, `eu`, `fed`, `in`, `jp`, `us1`, or `us2`. See [API endpoints](#section/API-Endpoints) for details.\n\nIf you prefer to use basic access authentication, you can do a Base64 encoding of your `<accessId>:<accessKey>` to authenticate your HTTPS request. The following is an example request, replace the placeholder `<encoded>` with your encoded Access ID and Access Key string:\n ```bash\n curl -H \"Authorization: Basic <encoded>\" -X GET https://api.<deployment>.sumologic.com/api/v1/users\n ```\n\n\nRefer to [API Authentication](https://help.sumologic.com/?cid=3012) for a Base64 example.\n\n## Status Codes\nGeneric status codes that apply to all our APIs. See the [HTTP status code registry](https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml) for reference.\n <table>\n <tr>\n <td> <strong>HTTP Status Code</strong> </td>\n <td> <strong>Error Code</strong> </td>\n <td> <strong>Description</strong> </td>\n </tr>\n <tr>\n <td> 301 </td>\n <td> moved </td>\n <td> The requested resource SHOULD be accessed through returned URI in Location Header. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---301-error---moved) for details.</td>\n </tr>\n <tr>\n <td> 401 </td>\n <td> unauthorized </td>\n <td> Credential could not be verified.</td>\n </tr>\n <tr>\n <td> 403 </td>\n <td> forbidden </td>\n <td> This operation is not allowed for your account type or the user doesn't have the role capability to perform this action. See [troubleshooting](https://help.sumologic.com/docs/api/troubleshooting/#api---401-error---credential-could-not-be-verified) for details.</td>\n </tr>\n <tr>\n <td> 404 </td>\n <td> notfound </td>\n <td> Requested resource could not be found. </td>\n </tr>\n <tr>\n <td> 405 </td>\n <td> method.unsupported </td>\n <td> Unsupported method for URL. </td>\n </tr>\n <tr>\n <td> 415 </td>\n <td> contenttype.invalid </td>\n <td> Invalid content type. </td>\n </tr>\n <tr>\n <td> 429 </td>\n <td> rate.limit.exceeded </td>\n <td> The API request rate is higher than 4 request per second or inflight API requests are higher than 10 request per second. </td>\n </tr>\n <tr>\n <td> 500 </td>\n <td> internal.error </td>\n <td> Internal server error. </td>\n </tr>\n <tr>\n <td> 503 </td>\n <td> service.unavailable </td>\n <td> Service is currently unavailable. </td>\n </tr>\n </table>\n\n## Filtering\nSome API endpoints support filtering results on a specified set of fields. Each endpoint that supports filtering will list the fields that can be filtered. Multiple fields can be combined by using an ampersand `&` character.\n\nExample: To get user with email `john@demo.com`:\n ```bash\n api.sumologic.com/v1/users?email=john@demo.com\n ```\n\n## Sorting\nSome API endpoints support sorting fields by using the `sortBy` query parameter. The default sort order is ascending. Prefix the field with a minus sign `-` to sort in descending order.\n\nFor example, to get 20 users sorted by their `email` in descending order:\n ```bash\n api.sumologic.com/v1/users?limit=20&sort=-email\n ```\n\n## Asynchronous Request\nAsynchronous requests do not wait for results, instead they immediately respond back with a job identifier while the job runs in the background. You can use the job identifier to track the status of the asynchronous job request. Here is a typical flow for an asynchronous request.\n1. Start an asynchronous job. On success, a job identifier is returned. The job identifier uniquely identifies\n your asynchronous job.\n\n2. Once started, use the job identifier from step 1 to track the status of your asynchronous job. An asynchronous\n request will typically provide an endpoint to poll for the status of asynchronous job. A successful response\n from the status endpoint will have the following structure:\n ```json\n {\n \"status\": \"Status of asynchronous request\",\n \"statusMessage\": \"Optional message with additional information in case request succeeds\",\n \"error\": \"Error object in case request fails\"\n }\n ```\n The `status` field can have one of the following values:\n 1. `Success`: The job succeeded. The `statusMessage` field might have additional information.\n 2. `InProgress`: The job is still running.\n 3. `Failed`: The job failed. The `error` field in the response will have more information about the failure.\n\n3. Some asynchronous APIs may provide a third endpoint (like [export result](#operation/getAsyncExportResult))\n to fetch the result of an asynchronous job.\n\n\n### Example\nLet's say we want to export a folder with the identifier `0000000006A2E86F`. We will use the [async export](#operation/beginAsyncExport) API to export all the content under the folder with `id=0000000006A2E86F`.\n1. Start an export job for the folder\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export\n ```\n See [authentication section](#section/Authentication) for more details about `accessId`, `accessKey`, and\n `deployment`.\n On success, you will get back a job identifier. In the response below, `C03E086C137F38B4` is the job identifier.\n ```bash\n {\n \"id\": \"C03E086C137F38B4\"\n }\n ```\n\n2. Now poll for the status of the asynchronous job with the [status](#operation/getAsyncExportStatus) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/status\n ```\n You may get a response like\n ```json\n {\n \"status\": \"InProgress\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n It implies the job is still in progress. Keep polling till the status is either `Success` or `Failed`.\n\n3. When the asynchronous job completes (`status != \"InProgress\"`), you can fetch the results with the\n [export result](#operation/getAsyncExportResult) endpoint.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.<deployment>.sumologic.com/api/v2/content/0000000006A2E86F/export/C03E086C137F38B4/result\n ```\n\n The asynchronous job may fail (`status == \"Failed\"`). You can look at the `error` field for more details.\n ```json\n {\n \"status\": \"Failed\",\n \"errors\": {\n \"code\": \"content1:too_many_items\",\n \"message\": \"Too many objects: object count(1100) was greater than limit 1000\"\n }\n }\n ```\n\n\n## Rate Limiting\n* A rate limit of four API requests per second (240 requests per minute) applies to all API calls from a user.\n* A rate limit of 10 concurrent requests to any API endpoint applies to an access key.\n\nIf a rate is exceeded, a rate limit exceeded 429 status code is returned.\n\n## Generating Clients\nYou can use [OpenAPI Generator](https://openapi-generator.tech) to generate clients from the YAML file to access the API.\n\n### Using [NPM](https://www.npmjs.com/get-npm)\n1. Install [NPM package wrapper](https://github.com/openapitools/openapi-generator-cli) globally, exposing the CLI\n on the command line:\n ```bash\n npm install @openapitools/openapi-generator-cli -g\n ```\n You can see detailed instructions [here](https://openapi-generator.tech/docs/installation#npm).\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n\n\n### Using [Homebrew](https://brew.sh/)\n1. Install OpenAPI Generator\n ```bash\n brew install openapi-generator\n ```\n\n2. Download the [YAML file](/docs/sumologic-api.yaml) and save it locally. Let's say the file is saved as `sumologic-api.yaml`.\n3. Use the following command to generate `python` client side code inside the `sumo/client/python` directory:\n ```bash\n openapi-generator generate -i sumologic-api.yaml -g python -o sumo/client/python\n ```\n"
version: 1.0.0
x-logo:
url: ./sumologic_logo.png
servers:
- url: https://api.au.sumologic.com/api/
description: AU deployment API server
- url: https://api.ca.sumologic.com/api/
description: CA deployment API server
- url: https://api.de.sumologic.com/api/
description: DE deployment API server
- url: https://api.eu.sumologic.com/api/
description: EU deployment API server
- url: https://api.fed.sumologic.com/api/
description: FED deployment API server
- url: https://api.jp.sumologic.com/api/
description: JP deployment API server
- url: https://api.kr.sumologic.com/api/
description: KR deployment API server
- url: https://api.in.sumologic.com/api/
description: IN deployment API server
- url: https://api.sumologic.com/api/
description: US1 deployment API server
- url: https://api.us2.sumologic.com/api/
description: US2 deployment API server
security:
- basicAuth: []
tags:
- name: contentManagement
description: "Content management API.\n\nYou can export, import, delete and copy content in your organization’s Library. For more information, see [Library](https://help.sumologic.com/?cid=5173). You can perform the request as a Content Administrator by using the `isAdminMode` parameter. For more information, see [Admin Mode](https://help.sumologic.com/docs/manage/content-sharing/admin-mode).\n<br/> <br/>\n### Example\nThe following example uses API endpoints in the US1 deployment. Sumo Logic has several deployments that are assigned depending on the geographic location and the date an account is created. For details determining your account's deployment, see [API endpoints](https://help.sumologic.com/?cid=3011).\nThe [Content Import API](#operation/beginAsyncImport) can be used to create or update a Search, Scheduled Search, or Dashboard. Here is an example creating a Scheduled Search:\n1. Get the identifier of your `Personal` folder.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.sumologic.com/api/v2/content/folders/personal\n ```\n\n Find the identifier of your `Personal` folder in the response.\n ```json\n {\n ...\n \"id\": \"0000000006A2E86F\", <----\n \"name\": \"Personal\",\n \"itemType\": \"Folder\",\n ...\n }\n ```\n\n You can use [getFolder](#operation/getFolder), [getAdminRecommededFolder](#operation/getAdminRecommendedFolderAsync),\n or [getGlobalFolder](#operation/getGlobalFolderAsync) endpoints to traverse the content tree and find the identifier of any\n folder you want to manage.\n\n2. Use the [Content Import API](#operation/beginAsyncImport) to create a new Scheduled Search inside your\n `Personal` folder.\n ```bash\n curl -X POST -u \"<accessId>:<accessKey>\" -H \"Content-Type: application/json\" -d @search.json https://api.sumologic.com/api/v2/content/folders/0000000006A2E86F/import\n ```\n\n The data file `search.json` in the above command has the following `SavedSearchWithScheduleSyncDefinition` object.\n ```json\n // file: search.json\n {\n \"type\": \"SavedSearchWithScheduleSyncDefinition\",\n \"name\": \"demo-scheduled-search\",\n \"description\": \"Runs every hour with timerange of 15m and sends email notifications\",\n \"search\": {\n \"queryText\": \"\\\"error\\\" and \\\"warn\\\"\",\n \"defaultTimeRange\": \"-15m\",\n \"byReceiptTime\": false,\n \"viewName\": \"\",\n \"viewStartTime\": null,\n \"queryParameters\": []\n },\n \"searchSchedule\": {\n \"cronExpression\": \"0 0/15 * * * ? *\",\n \"displayableTimeRange\": \"-15m\",\n \"parseableTimeRange\": {\n \"from\": {\n \"relativeTime\": \"-15m\",\n \"type\": \"RelativeTimeRangeBoundary\"\n },\n \"to\": null,\n \"type\": \"BeginBoundedTimeRange\"\n },\n \"timeZone\": \"America/Los_Angeles\",\n \"threshold\": null,\n \"notification\": {\n \"taskType\": \"EmailSearchNotificationSyncDefinition\",\n \"toList\": [\n \"ops@acme.org\"\n ],\n \"subjectTemplate\": \"Search Results: {{SearchName}}\",\n \"includeQuery\": true,\n \"includeResultSet\": true,\n \"includeHistogram\": true,\n \"includeCsvAttachment\": false\n },\n \"muteErrorEmails\": false,\n \"scheduleType\": \"1Hour\",\n \"parameters\": []\n }\n }\n ```\n\n The response of above request will have the job identifier that you can use to track the status of the import job.\n ```json\n {\n \"id\": \"74DC17FA765C7443\"\n }\n ```\n\n3. Use the job identifier from the import request to get the [status](#operation/getAsyncImportStatus) of the\n import job.\n ```bash\n curl -X GET -u \"<accessId>:<accessKey>\" https://api.sumologic.com/api/v2/content/folders/0000000006A2E86F/import/74DC17FA765C7443/status\n ```\n\n If you are importing a large item, you might have to wait for the import job to finish. The following is an\n example response from a completed job.\n ```json\n {\n \"status\": \"Success\",\n \"statusMessage\": null,\n \"error\": null\n }\n ```\n"
x-displayName: Content
paths:
/v2/content/path:
get:
tags:
- contentManagement
summary: Get Content Item By Path.
description: "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. For items in \"Personal\" folder, the base path is \"/Library/Users/user@sumo.com\" where \"user@sumo.com\" is the email address of the user. For example if a user with email address `wile@acme.com` has `Rockets` folder inside Personal folder, the path of Rockets folder will be `/Library/Users/wile@acme.com/Rockets`.\n\nFor items in \"Admin Recommended\" folder, the base path is \"/Library/Admin Recommended\". For example, given a folder `Acme` in Admin Recommended folder, the path will be `/Library/Admin Recommended/Acme`."
operationId: getItemByPath
parameters:
- name: path
in: query
description: Path of the content item to retrieve.
required: true
schema:
type: string
example: /Library/Users/user@sumo.com/SampleFolder
responses:
'200':
description: Content item corresponding to the given path.
content:
application/json:
schema:
$ref: '#/components/schemas/Content'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{contentId}/path:
get:
tags:
- contentManagement
summary: Get Path Of An Item.
description: 'Get full path of a content item with the given identifier.
'
operationId: getPathById
parameters:
- name: contentId
in: path
description: Identifier of the content item to get the path.
required: true
schema:
type: string
responses:
'200':
description: Full path of the content item.
content:
application/json:
schema:
$ref: '#/components/schemas/ContentPath'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{id}/export:
post:
tags:
- contentManagement
summary: Start A Content Export Job.
description: '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.
If 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 exported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less.
The results from the export are compatible with the Library import feature in the Sumo Logic user interface as well as the API content import job.'
operationId: beginAsyncExport
parameters:
- name: id
in: 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.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: Export job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{contentId}/export/{jobId}/status:
get:
tags:
- contentManagement
summary: Content Export Job Status.
description: 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.
operationId: getAsyncExportStatus
parameters:
- name: contentId
in: path
description: The identifier of the exported content item.
required: true
schema:
type: string
- name: jobId
in: path
description: The identifier of the asynchronous export job.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: The status of the export job.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncJobStatus'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{contentId}/export/{jobId}/result:
get:
tags:
- contentManagement
summary: Content Export Job Result.
description: 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.
operationId: getAsyncExportResult
parameters:
- name: contentId
in: path
description: The identifier of the exported content item.
required: true
schema:
type: string
- name: jobId
in: path
description: The identifier of the asynchronous job.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: The result of export job.
content:
application/json:
schema:
$ref: '#/components/schemas/ContentSyncDefinition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/folders/{folderId}/import:
post:
tags:
- contentManagement
summary: Start A Content Import Job.
description: 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 name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less.
operationId: beginAsyncImport
parameters:
- name: folderId
in: 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.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
- name: overwrite
in: query
description: Set this to "true" to overwrite a content item if the name already exists.
required: false
schema:
type: boolean
default: false
requestBody:
description: The content to import.
content:
application/json:
schema:
$ref: '#/components/schemas/ContentSyncDefinition'
required: true
responses:
'200':
description: Import job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponse'
default:
description: The operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/folders/{folderId}/import/{jobId}/status:
get:
tags:
- contentManagement
summary: Content Import Job Status.
description: Get the status of a content import job for the given job identifier.
operationId: getAsyncImportStatus
parameters:
- name: folderId
in: path
description: The identifier of the folder to import into.
required: true
schema:
type: string
- name: jobId
in: path
description: The identifier of the import request.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: The status of the import job.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncJobStatus'
default:
description: The operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/folders/{folderId}/import/{jobId}/result:
get:
tags:
- contentManagement
summary: Content Import Job Result.
description: Get the complete summary of content import job for the given job identifier.
operationId: getAsyncImportResult
parameters:
- name: folderId
in: path
description: The identifier of the folder to import into.
required: true
schema:
type: string
- name: jobId
in: path
description: The identifier of the import request.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: The result of the import job.
content:
application/json:
schema:
$ref: '#/components/schemas/ImportResult'
default:
description: The operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{id}/delete:
delete:
tags:
- contentManagement
summary: Start A Content Deletion Job.
description: Start an asynchronous content deletion job with the given identifier.
operationId: beginAsyncDelete
parameters:
- name: id
in: 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.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: Deletion job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{id}/delete/{jobId}/status:
get:
tags:
- contentManagement
summary: Content Deletion Job Status.
description: Get the status of an asynchronous content deletion job request for the given job identifier.
operationId: getAsyncDeleteStatus
parameters:
- name: id
in: path
description: Identifier of the content to delete.
required: true
schema:
type: string
- name: jobId
in: path
description: The identifier of the asynchronous job.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: The status of the content deletion job.
content:
application/json:
schema:
$ref: '#/components/schemas/AsyncJobStatus'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{id}/copy:
post:
tags:
- contentManagement
summary: Start A Content Copy Job.
description: 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.
operationId: beginAsyncCopy
parameters:
- name: id
in: 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.
required: true
schema:
type: string
- name: destinationFolder
in: query
description: The identifier of the destination folder.
required: true
schema:
type: string
- name: isAdminMode
in: header
description: Set this to "true" if you want to perform the request as a Content Administrator.
required: false
schema:
type: string
responses:
'200':
description: Content copy job has been scheduled.
content:
application/json:
schema:
$ref: '#/components/schemas/BeginAsyncJobResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v2/content/{id}/copy/{jobId}/status:
get:
tags:
- contentManagement
summary: Content Copy Job Status.
description: '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}`.
'
operationId: asyncCopyStatus
parameters:
- name: id
in: path
description: The identifier of the
# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sumo-logic/refs/heads/main/openapi/sumo-logic-contentmanagement-api-openapi.yml