---
title: "Display the status of a batch"
method: GET
path: "/batch/{batchId}/status"
---

# Display the status of a batch

`GET /batch/{batchId}/status`

Returns the status of a batch. A batch status can be Incomplete, CommitInProgress, Committed, Rolledback or Failed.

## Path parameters

- `batchId` string, GUID, required

## Response `200`

OK - returns the status of the batch.

- object
  - `batchId` string, GUID
  - `status` 'Incomplete' | 'CommitInProgress' | 'Committed' | 'Rolledback' | 'Failed'

## Other responses

- `400` — Bad request - Could be a bad batch ID or a batch ID that doesn't exist.
- `401` — Unauthorised - either you have not provided any credentials, or your credentials are not recognised.
- `403` — Forbidden - you have been authorised, but you are not allowed to access this resource.
- `410` — Gone - the specified batch has expired and is no longer available.
- `429` — You have sent too many requests in a given amount of time. Please back-off for the time in the Retry-After header (in seconds) and try again.

---

[API](https://skmtc.net/uk-hydrographic-office/apis/ukho-file-share-service-apis.md) · [All operations](https://skmtc.net/uk-hydrographic-office/apis/ukho-file-share-service-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/uk-hydrographic-office/ukho-file-share-service-apis/revisions/31121f0e92c4/schema)