---
title: "Get the status of an incremental update"
slug: "get-the-status-of-an-incremental-update"
abstract: "How to use the Ingestion API for Sitecore Search to get the status of a request to incrementally add, edit, or delete an index document."
---
# Get the status of an incremental update

You can get the status of a request to [create](https://doc.sitecore.com/search/en/developers/search-developer-guide/using-the-ingestion-api-to-add-content-to-an-index/create-an-index-document/creating-a-document-by-passing-attribute-values.html "Creating a document by passing attribute values"), [edit](https://doc.sitecore.com/search/en/developers/search-developer-guide/using-the-ingestion-api-to-add-content-to-an-index/updating-a-document.html "Updating a document"), or [delete](https://doc.sitecore.com/search/en/developers/search-developer-guide/using-the-ingestion-api-to-add-content-to-an-index/deleting-a-document.html "Deleting a document") an index document made though the Ingestion API. To do this, make a `GET` call to `{base-URL}/ingestion/v1/domains/{domain}/sources/{source}/entities/{entity}/status/{incrementalUpdateId}`. You can check the status of one index document in one request.

View the [swagger reference](https://doc.sitecore.com/search/en/developers/ingestion-api/index.html) to see the detailed data model,

> [!note]
> Get the value of `incrementalUpdateId` from the response to a create, edit, or delete request to the Ingestion API.

Here's a sample cURL to get the status of an index document you just created:

```

curl --location '{base-URL}/ingestion/v1/domains/{domain}/sources/{source}/entities/{entity}/status/2529ecba-efce-1726-3021-7d6911a962ac' \
--header 'Content-Type: application/json' \
--header 'Authorization: <API_KEY>'
```

Here's a sample response when a index document was successfully created:

```text
{"status":"finished"}
```

Here's a sample response when an index document wasn't created:

```text
{"status":"failed"}
```

## States of an incremental update

When you send a request to [add](https://doc.sitecore.com/search/en/developers/search-developer-guide/using-the-ingestion-api-to-add-content-to-an-index/create-an-index-document/creating-a-document-by-passing-attribute-values.html "Creating a document by passing attribute values"), [edit](https://doc.sitecore.com/search/en/developers/search-developer-guide/using-the-ingestion-api-to-add-content-to-an-index/updating-a-document.html "Updating a document"), or [delete](https://doc.sitecore.com/search/en/developers/search-developer-guide/using-the-ingestion-api-to-add-content-to-an-index/deleting-a-document.html "Deleting a document") an index document, it can be in any of the following states:

- *failed* - the request has failed and the index document was not created, updated, or deleted. Retry the request.
- *running* - the request is ongoing. Check the status after some time.
- *finished* - the request was successful. The index document has been created, updated, or deleted.