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

# Check connector health

> Live probe of one stored connector.

### Path parameters

**brand\_id** `string (uuid)` *required*

**connector\_id** `string (string)` *required*

### Request body

No request body.

### Response

`object`

**connector\_id** `string (uuid)` *required*

**connector\_key** `string` *required*

**connector\_type** `string` *required*

**healthy** `boolean` *required*

**latency\_ms** `integer` *required*

**error** `string`

**checked\_at** `string (date-time)` *required*

### Status codes

| Code | Meaning |
| - | - |
| `200` | Live probe of one stored connector. |
| `400` | Validation error |
| `401` | Unauthorized |
| `404` | Not found |
| `429` | Rate limited |
| `500` | Internal error |

### Using this contract

Read the [source OpenAPI document](https://docs.stateset.com/spec/temporal.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

```bash cURL theme={null}
curl --silent --show-error --fail-with-body --request POST \
  --url 'https://api.workstream.stateset.com/v1/brands/{brand_id}/connectors/{connector_id}/health' \
  --header "x-api-key: $STATESET_TEMPORAL_API_KEY"
```

```json 200 theme={null}
{
  "connector_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "connector_key": "string",
  "connector_type": "string",
  "healthy": true,
  "latency_ms": 250,
  "error": "string",
  "checked_at": "2026-08-31T14:22:05Z"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.