# Describe refresh job

Inspect refresh progress using the unquoted integer job ID returned at submission.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/describe/

## Section links

- [cURL command](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/describe/#curl-command)
- [Default request](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/describe/#default-request)
- [Sample response](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/describe/#sample-response)
- [Request fields](https://milvus-io.github.io/milvus-sdk-node/rest-api/external-collections/describe/#request-fields)

`POST /v2/vectordb/jobs/external_collection/describe`

Replace `https://your-cluster.example.com` with your Milvus endpoint. Set `MILVUS_TOKEN` for authentication or omit the Authorization header on an unauthenticated cluster.

## cURL command

```bash
curl --request POST --url 'https://your-cluster.example.com/v2/vectordb/jobs/external_collection/describe' \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer ${MILVUS_TOKEN}" \
  --data-raw '{
  "jobId": 123456789
}'
```

## Default request

```json
{
  "jobId": 123456789
}
```

## Sample response

```json
{
  "code": 0,
  "data": {
    "jobId": 123456789,
    "collectionName": "books",
    "state": "RefreshCompleted",
    "progress": 100,
    "externalSource": "s3://example-bucket/books/",
    "externalSpec": "{\"format\":\"parquet\"}",
    "startTime": 1795099200000,
    "endTime": 1795099202000
  }
}
```

## Request fields

- `jobId` integer (required)
  Unquoted int64 job ID. Paste the exact digits returned by the refresh request.

See [`HttpClient.getRefreshExternalCollectionProgress`](https://milvus-io.github.io/milvus-sdk-node/api-reference/http-client/#getrefreshexternalcollectionprogress) for the Node.js SDK method.
