export
Creates, updates, deletes, gets or lists an export resource.
Overview
| Name | export |
| Type | Resource |
| Id | sumologic.content.export |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
beginAsyncExport | exec | id, region | isAdminMode | Schedule an asynchronous export of content with the given identifier. You will get back an asynchronous job identifier on success. Use the [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. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | 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. |
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
isAdminMode | string | Set this to "true" if you want to perform the request as a Content Administrator. |
Lifecycle Methods
- beginAsyncExport
Schedule an asynchronous export of content with the given identifier. You will get back an asynchronous job identifier on success. Use the [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.
EXEC sumologic.content.export.beginAsyncExport
@id='{{ id }}' --required,
@region='{{ region }}' --required,
@isAdminMode='{{ isAdminMode }}'
;