---
title: "Test connection profile"
---

> Documentation Index
> Fetch the complete documentation index at: https://www.arroyo.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Test connection profile

Path: Arroyo REST API › connection_profiles

`POST /v1/connection_profiles/test`

URL: `http://localhost:5115/api/v1/connection_profiles/test`

## Request body

_Required._

- `config` (`test_connection_profile.config`; unknown, required)
- `connector` (`test_connection_profile.connector`; string, required)
- `name` (`test_connection_profile.name`; string, required)

## Example request

```json
{
  "config": null,
  "connector": "string",
  "name": "string"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url http://localhost:5115/api/v1/connection_profiles/test \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": null,
  "connector": "string",
  "name": "string"
}
'
```

### TypeScript

```typescript
const url = 'http://localhost:5115/api/v1/connection_profiles/test';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({config: null, connector: 'string', name: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "http://localhost:5115/api/v1/connection_profiles/test"

payload = {
    "config": None,
    "connector": "string",
    "name": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Result of testing connection profile

#### Example

```json
{
  "done": true,
  "error": true,
  "message": "string"
}
```

- `done` (`test_connection_profile.response.200.done`; boolean, required)
- `error` (`test_connection_profile.response.200.error`; boolean, required)
- `message` (`test_connection_profile.response.200.message`; string, required)


Source: https://www.arroyo.dev/docs/api/test-connection-profile/index.md
