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).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sumo-logic:sumo-logic-partitionmanagement-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Sumo Logic Partition Management API
description: '# Getting Started
Welcome to the Sumo Logic API reference.'
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.'
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:
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
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'
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
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
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
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
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
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'
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