Sign in

v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB
partitionManagement

Get a list of partitions.

Get a list of all partitions in the organization. The response is paginated with a default limit of 100 partitions per page.

get/v1/partitions

Query parameters

limitinteger

Limit the number of partitions returned in the response. The number of partitions returned may be less than the limit.

tokenstring

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.

viewTypesstring[]

The type of partitions to retrieve. Valid values are:

  1. DefaultView: To get General Index partition.
  2. Partition: To get user defined views/partitions.
  3. AuditIndex: To get the internal audit indexes. Eg. sumologic_audit_events.

More than one type of partitions can be retrieved in same request.

Response

A paginated list of partitions in the organization.

nextstring

Next continuation token.

Example response

{
  "data": [
    {
      "name": "apache",
      "routingExpression": "_sourcecategory=*/Apache",
      "analyticsTier": "continuous",
      "retentionPeriod": 365,
      "isIncludedInDefaultSearch": true,
      "newRetentionPeriod": 300,
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006743FDD",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006743FE8",
      "id": "1",
      "totalBytes": 42,
      "indexType": "Partition"
    }
  ],
  "next": "1"
}