---
title: "Get mail status REST API | HitKeep"
description: "Reference for the HitKeep REST API operation Get mail status, including request parameters, responses, and authentication notes."
canonical: "https://hitkeep.com/api/operations/apiadminsystemmail/"
---

# Get mail status REST API

GET

/api/admin/system/mail

FetchcURL

```
const url = 'http://127.0.0.1:25737/api/admin/system/mail';
const options = {method: 'GET', headers: {cookie: 'hk_token=<hk_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```
curl --request GET \
  --url http://127.0.0.1:25737/api/admin/system/mail \
  --cookie hk_token=<hk_token>
```

-

Returns configured mail driver, host, port, encryption, sender identity, masked username, password presence, and last test result.

## Authorizations

- **[cookieAuth](https://hitkeep.com/api/#cookieauth)**

## Responses

### 200

System mail status

application/json

object

**configured**

boolean

**driver**

string

**encryption**

string

**from_address**

string

**from_name**

string

**host**

string

**last_test_at**

string format: date-time

**last_test_ok**

boolean

**password_set**

boolean

**port**

integer

**username**

string

##### Examplegenerated

```
{
  "configured": true,
  "driver": "example",
  "encryption": "example",
  "from_address": "example",
  "from_name": "example",
  "host": "example",
  "last_test_at": "2026-04-15T12:00:00Z",
  "last_test_ok": true,
  "password_set": true,
  "port": 1,
  "username": "example"
}
```

[Previous Get ingest volume](https://hitkeep.com/api/operations/apiadminsystemingest/)[Next Send test email](https://hitkeep.com/api/operations/apiadminsystemmailtest/)