Partition management API. Creating a Partition allows you to improve search performance by searching over a smaller number of messages. For more information, see [Manage Partitions](https://help.sumologic.com/?cid=5231).
openapi: 3.0.0
info:
title: Sumo Logic accessKeyManagement partitionManagement 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: partitionManagement
description: 'Partition management API.
Creating a Partition allows you to improve search performance by searching over a smaller number of messages. For more information, see [Manage Partitions](https://help.sumologic.com/?cid=5231).
'
x-displayName: Partitions
paths:
/v1/partitions:
get:
tags:
- partitionManagement
summary: Get A List Of Partitions.
description: Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page.
operationId: listPartitions
parameters:
- name: limit
in: query
description: Limit the number of partitions returned in the response. The number of partitions returned may be less than the `limit`.
required: false
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
default: 100
- name: token
in: 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.
required: false
schema:
type: string
- name: viewTypes
in: 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."
required: false
style: form
explode: false
schema:
type: array
items:
pattern: ^(AuditIndex|Partition|DefaultView)$
type: string
example:
- AuditIndex
- Partition
responses:
'200':
description: A paginated list of partitions in the organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ListPartitionsResponse'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- partitionManagement
summary: Create A New Partition.
description: Create a new partition.
operationId: createPartition
parameters: []
requestBody:
description: Information about the new partition.
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePartitionDefinition'
required: true
responses:
'200':
description: The partition has been created.
content:
application/json:
schema:
$ref: '#/components/schemas/Partition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/partitions/{id}:
get:
tags:
- partitionManagement
summary: Get A Partition.
description: Get a partition with the given identifier from the organization.
operationId: getPartition
parameters:
- name: id
in: path
description: Identifier of partition to return.
required: true
schema:
type: string
responses:
'200':
description: Partition object that was requested.
content:
application/json:
schema:
$ref: '#/components/schemas/Partition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
put:
tags:
- partitionManagement
summary: Update A Partition.
description: Update an existing partition in the organization.
operationId: updatePartition
parameters:
- name: id
in: path
description: Identifier of the partition to update.
required: true
schema:
type: string
requestBody:
description: Information to update about the partition.
content:
application/json:
schema:
$ref: '#/components/schemas/UpdatePartitionDefinition'
required: true
responses:
'200':
description: The partition was successfully modified.
content:
application/json:
schema:
$ref: '#/components/schemas/Partition'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/partitions/{id}/decommission:
post:
tags:
- partitionManagement
summary: Decommission A Partition.
description: Decommission a partition with the given identifier from the organization.
operationId: decommissionPartition
parameters:
- name: id
in: path
description: Identifier of the partition to decommission.
required: true
schema:
type: string
responses:
'200':
description: The partition was decommissioned successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/partitions/{id}/cancelRetentionUpdate:
post:
tags:
- partitionManagement
summary: Cancel A Retention Update For A Partition
description: Cancel update to retention of a partition for which retention was updated previously using `reduceRetentionPeriodImmediately` parameter as false
operationId: cancelRetentionUpdate
parameters:
- name: id
in: path
description: Identifier of the partition to cancel the retention update for.
required: true
schema:
type: string
example: 1
responses:
'204':
description: The retention update was cancelled successfully.
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/partitions/quota:
get:
tags:
- partitionManagement
summary: Provides Information About Partitions Quota.
description: Every customer can use a limited number of partitions. This endpoint allows learning about these limitations and remaining quota.
operationId: getPartitionsQuota
responses:
'200':
description: Current state of partitions quota usage (limit and remaining).
content:
application/json:
schema:
$ref: '#/components/schemas/PartitionsQuotaUsage'
default:
description: Operation failed with an error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
UpdatePartitionDefinition:
type: object
properties:
retentionPeriod:
type: integer
description: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
example: 365
reduceRetentionPeriodImmediately:
type: boolean
description: This is required if the newly specified `retentionPeriod` is less than the existing retention period. In such a situation, a value of `true` says that data between the existing retention period and the new retention period should be deleted immediately; if `false`, such data will be deleted after seven days. This property is optional and ignored if the specified `retentionPeriod` is greater than or equal to the current retention period.
default: false
isCompliant:
type: boolean
description: Whether to mark a partition as compliant. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition marked as compliant. A partition once marked compliant, cannot be marked non-compliant later.
example: false
default: false
isIncludedInDefaultSearch:
type: boolean
description: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
routingExpression:
maxLength: 16384
minLength: 1
type: string
description: The query that defines the data to be included in the partition.
example: _sourcecategory=*/Apache
ViewRetentionProperties:
type: object
properties:
newRetentionPeriod:
type: integer
description: If the retention period is scheduled to be updated in the future (i.e., if retention period is previously reduced with value of reduceRetentionPeriodImmediately as false), this property gives the future value of retention period while retentionPeriod gives the current value. retentionPeriod will take up the value of newRetentionPeriod after the scheduled time.
format: int32
example: 300
retentionEffectiveAt:
type: string
description: When the newRetentionPeriod will become effective in UTC format.
format: date-time
MetadataModel:
required:
- createdAt
- createdBy
- modifiedAt
- modifiedBy
type: object
properties:
createdAt:
type: string
description: Creation timestamp in UTC in [RFC3339](https://tools.ietf.org/html/rfc3339) format.
format: date-time
example: 2018-10-16 09:10:00+00:00
createdBy:
type: string
description: Identifier of the user who created the resource.
example: 0000000006743FDD
modifiedAt:
type: string
description: Last modification timestamp in UTC.
format: date-time
example: 2018-10-16 09:10:00+00:00
modifiedBy:
type: string
description: Identifier of the user who last modified the resource.
example: 0000000006743FE8
PartitionsQuotaUsage:
required:
- quota
- remaining
type: object
properties:
quota:
type: integer
description: Maximum number of Partitions allowed.
format: int32
example: 200
remaining:
type: integer
description: Remaining number of Partitions allowed.
format: int32
example: 121
Partition:
type: object
allOf:
- $ref: '#/components/schemas/CreatePartitionDefinition'
- $ref: '#/components/schemas/ViewRetentionProperties'
- $ref: '#/components/schemas/MetadataModel'
- required:
- id
- totalBytes
properties:
id:
type: string
description: Unique identifier for the partition.
example: '1'
totalBytes:
type: integer
description: Size of data in partition in bytes.
format: int64
example: 42
isActive:
type: boolean
description: This has the value `true` if the partition is active and `false` if it has been decommissioned.
indexType:
pattern: ^(DefaultIndex|AuditIndex|Partition)$
type: string
description: This has the value `DefaultIndex`, `AuditIndex`or `Partition` depending upon the type of partition.
example: Partition
dataForwardingId:
type: string
description: Id of the data forwarding configuration to be used by the partition.
ErrorDescription:
required:
- code
- message
type: object
properties:
code:
type: string
description: An error code describing the type of error.
example: auth:password_too_short
message:
type: string
description: A short English-language description of the error.
example: Your password was too short.
detail:
type: string
description: An optional fuller English-language description of the error.
example: Your password was 5 characters long, the minimum length is 12 characters. See http://example.com/password for more information.
meta:
type: object
description: An optional list of metadata about the error.
example:
minLength: 12
actualLength: 5
CreatePartitionDefinition:
required:
- name
- routingExpression
type: object
properties:
name:
maxLength: 255
type: string
description: The name of the partition.
example: apache
routingExpression:
maxLength: 16384
minLength: 1
type: string
description: The query that defines the data to be included in the partition.
example: _sourcecategory=*/Apache
analyticsTier:
type: string
description: "The Data Tier where the data in the partition will reside. Possible values are:\n 1. `continuous`\n 2. `frequent`\n 3. `infrequent`\nNote: The \"infrequent\" and \"frequent\" tiers are only available to Cloud Flex Credits Enterprise Suite accounts."
example: continuous
x-limited-description: The Data Tier where the data in the partition will reside. You can leave it empty or send `flex`. It is the only value applicable on your account.
x-limited-example: flex
retentionPeriod:
type: integer
description: The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
example: 365
default: -1
isCompliant:
type: boolean
description: Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
example: false
default: false
isIncludedInDefaultSearch:
type: boolean
description: Indicates whether the partition is included in the default search scope. When executing a query such as "error | count," certain partitions are automatically part of the search scope. However, for specific partitions, the user must explicitly mention the partition using the _index term, as in "_index=webApp error | count". This property governs the default inclusion of the partition in the search scope. Configuring this property is exclusively permitted for flex partitions.
example: true
ErrorResponse:
required:
- errors
- id
type: object
properties:
id:
type: string
description: An identifier for the error; this is unique to the specific API request.
example: IUUQI-DGH5I-TJ045
errors:
type: array
description: A list of one or more causes of the error.
example:
- code: auth:password_too_short
message: Your password was too short.
- code: auth:password_character_classes
message: Your password did not contain any non-alphanumeric characters
items:
$ref: '#/components/schemas/ErrorDescription'
ListPartitionsResponse:
required:
- data
type: object
properties:
data:
type: array
description: List of partitions.
items:
$ref: '#/components/schemas/Partition'
next:
type: string
description: Next continuation token.
example: '1'
securitySchemes:
basicAuth:
type: http
scheme: basic
x-tagGroups:
- name: Archive Management
tags:
- archiveManagement
- name: Health Events
tags:
- healthEvents
- name: Infrequent Data Tier
tags:
- logSearchesEstimatedUsage
- name: Ingest Budgets Management V2
tags:
- ingestBudgetManagementV2
- name: Library Management
tags:
- appManagement
- appManagementV2
- contentManagement
- dashboardManagement
- folderManagement
- lookupManagement
- contentPermissions
- logSearchesManagement
- parsersLibraryManagement
- name: Metrics
tags:
- metricsSearchesManagement
- transformationRuleManagement
- metricsQuery
- metricsSearchesManagementV2
- name: Security Management
tags:
- accessKeyManagement
- oauthManagement
- accountManagement
- passwordPolicy
- policiesManagement
- samlConfigurationManagement
- serviceAllowlistManagement
- serviceAccountManagement
- scimUserManagement
- name: Organizations Management
tags:
- orgsManagement
- name: Settings Management
tags:
- connectionManagement
- dynamicParsingRuleManagement
- extractionRuleManagement
- fieldManagementV1
- partitionManagement
- scheduledViewManagement
- logsDataForwardingManagement
- dataDeletionRules
- name: Tokens Management
tags:
- tokensLibraryManagement
- name: Tracing
tags:
- traces
- spanAnalytics
- serviceMap
- name: Users and Roles Management
tags:
- roleManagement
- roleManagementV2
- userManagement
- name: Threat Intel Ingest Management
tags:
- threatIntelIngest
- threatIntelIngestProducer
- name: OpenTelemetry Collector Management
tags:
- otCollectorManagementExternal
- name: Source Template Management
tags:
- sourceTemplateManagementExternal
- name: Schema Base Management
tags:
- schemaBaseManagement
- name: Event Analytics Management
tags:
- eventAnalytics
- name: Budget Management
tags:
- budgetManagement
- name: Macro Management
tags:
- macroManagement
- name: Muting Schedules Management
tags:
- mutingSchedulesLibraryManagement
- name: SLO Management
tags:
- slosLibraryManagement
- name: Monitor Management
tags:
- monitorsLibraryManagement