# Test a connector configuration

> Source: https://docs.clonepartner.com/api-reference/connectors/test-connector-config/

`POST /api/connectors/test`

Instantiates a connector from the provided type and config (without persisting) and runs per-type validation checks.

**Operation ID:** `testConnectorConfig`

## Authentication

### Option 1

- **BearerAuth** (`http bearer`)
  API key token. Create via POST /api/api-keys. Format: `envoy_<hex>`

### Option 2

- **CookieAuth** (`apiKey`)
  Session cookie set after login + TOTP verification

## Request body

The request body is required.

### `application/json`

- Type: `object`
- Properties:
  - `type` (`string`, `required`)
  - `config` (`object`, `required`)

## Success responses

### 200

Test results

**Content type:** `application/json`

- Reference: `ConnectorTestResult`
  - Type: `object`
  - Properties:
    - `ok` (`boolean`, `required`)
    - `checks` (`array<ConnectorCheck>`, `required`)
      - Items:
        - Reference: `ConnectorCheck`
          - Type: `object`
          - Properties:
            - `name` (`string`, `required`) — Check name (e.g. Authenticate, Write probe)
            - `ok` (`boolean`, `required`)
            - `message` (`string`) — Short friendly summary (set on failure)
            - `error` (`ConnectorCheckError`)
              - Reference: `ConnectorCheckError`
                - Properties:
                  - `name` (`string`, `required`) — Error class name (e.g. MongoServerError)
                  - `message` (`string`, `required`) — Raw error message
                  - `code` (`string`) — Driver/SDK error code
            - `duration_ms` (`number`, `required`)

## Examples

### cURL

```bash
curl --request POST \
  --url 'https://your-envoy.example.com/api/connectors/test' \
  --header 'Authorization: Bearer $API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "string",
  "config": {}
}'
```

### JavaScript (fetch)

```javascript
const response = await fetch('https://your-envoy.example.com/api/connectors/test', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "type": "string",
    "config": {}
  }),
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);
```