# Check status of CSV webdomain import

Retrieves the current status and progress of a CSV webdomain import operation.

## Endpoints

`GET /bsp/api/v1/bmp/webdomains/csvimport/summary/{csv_file_id}`

## Request

### Request URL

`https://{server-hostname}:8383/bsp/api/v1/bmp/webdomains/csvimport/summary/{csv_file_id}`

### Scope

`BrowserManager.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** (`string`, Mandatory): `application/json`

#### Path Parameters

- **csv_file_id** (`string`, Mandatory)

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/bsp/api/v1/bmp/webdomains/csvimport/summary/{csv_file_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP 200

Response Body — `application/json`

**JSON Object**

CSV import progress/status response.

- **total** (`string`): Total number of webdomains in the CSV file
- **status** (`string`): Current import status: `in_progress`, `success`, or `failed`

#### Sample Response: HTTP 200

Import in progress:

```json
{
  "total": "2",
  "status": "in_progress"
}
```

Import completed:

```json
{
  "total": "2",
  "status": "success"
}
```

Invalid CSV file ID:

```json
{
  "status": "null"
}
```

### HTTP 401

Response Body — `application/json`

**JSON Object**

- **errorCode** (`long`): Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
- **errorMsg** (`string`): Authentication failure reason

#### Sample Response: HTTP 401

Unauthorized:

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

### HTTP 403

Response Body — `application/json`

**JSON Object**

- **errorCode** (`long`): Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
- **errorMsg** (`string`): Message indicating insufficient privileges to access this resource

#### Sample Response: HTTP 403

Forbidden:

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

### HTTP 429

Response Body — `application/json`

**JSON Object**

- **errorCode** (`long`): Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
- **errorMsg** (`string`): Rate limit exceeded message with retry guidance

#### Sample Response: HTTP 429

Rate limit exceeded:

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
```

### HTTP 500

Response Body — `application/json`

**JSON Object**

Internal server error when fetching CSV import status.

- **error_description** (`string`): Message describing the server-side failure
- **error_code** (`string`): Internal server error code

#### Sample Response: HTTP 500

Server error:

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

## Possible Response Codes

- **200** — HTTP code
- **401** — HTTP code
- **403** — HTTP code
- **429** — HTTP code
- **500** — HTTP code

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**Duration:** 1 minute | **Threshold:** 60 | **Lock period:** 5 minutes

Duration — Time window for the threshold.  
Threshold — Number of API calls allowed within the specified duration.  
Lock Period — Wait time before consecutive API requests.