---
title: "Bulk index groups"
method: POST
path: "/api/index/v1/bulkindexgroups"
tags: ["Permissions"]
---

# Bulk index groups

`POST /api/index/v1/bulkindexgroups`

Replaces the groups in a datasource using paginated batch API calls. Please refer to the [bulk indexing](https://developers.glean.com/indexing/documents/bulk-upload-model) documentation for an explanation of how to use bulk endpoints.
Note: Any groups deleted from the existing set will have their associated memberships deleted as well.

## Request body

- BulkIndexGroupsRequest — Describes the request body for the /bulkindexgroups API call
  - `uploadId` string, required — Unique id that must be used for this instance of datasource groups upload
  - `isFirstPage` boolean — true if this is the first page of the upload. Defaults to false
  - `isLastPage` boolean — true if this is the last page of the upload. Defaults to false
  - `forceRestartUpload` boolean — Flag to discard previous upload attempts and start from scratch. Must be specified with isFirstPage=true
  - `datasource` string, required — datasource of the groups
  - `groups` DatasourceGroupDefinition[], required — batch of groups for the datasource
    - `name` string, required — name of the group. Should be unique among all groups for the datasource, and cannot have spaces.
  - `disableStaleDataDeletionCheck` boolean — True if older group data needs to be force deleted after the upload completes. Defaults to older data being deleted only if the percentage of data being deleted is less than a reasonable threshold. This must only be set when `isLastPage = true`

## Response `200`

OK

## Other responses

- `400` — Bad Request
- `401` — Not Authorized
- `409` — Conflict

---

[API](https://skmtc.dev/gleanwork/apis/glean-indexing-api.md) · [All operations](https://skmtc.dev/gleanwork/apis/glean-indexing-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gleanwork/glean-indexing-api/revisions/b47bf641faba/schema)