---
title: "Test the exact saved connection/environment without accepting credentials."
method: POST
path: "/v1/connections/{connectionId}/test"
tags: ["Connections"]
---

# Test the exact saved connection/environment without accepting credentials.

`POST /v1/connections/{connectionId}/test`

## Request

- Base URL: `https://signaledi.com/api`
- URL: `https://signaledi.com/api/v1/connections/{connectionId}/test`
- Auth: HTTP bearer

## Path parameters

- `connectionId` string, required

## Request body

- ConnectionTestRequest
  - `environment` 'LAB' | 'CERTIFICATION' | 'PRODUCTION', required

## Response `200`

Sanitized test result and workspace.

- ConnectionTestResult
  - `ok` true, required
  - `test` object, required
  - `workspace` object, required
  - `idempotentReplay` boolean, required

## Other responses

- `400`: `Idempotency-Key` header missing or not 8-128 characters (`code` IDEMPOTENCY_KEY_REQUIRED), or the request body failed validation (`code` e.g. VALIDATION_ERROR, NO_WORKSPACE, BATCH_TOO_LARGE).
- `401`: Missing or invalid API key (`code` AUTH_UNAUTHORIZED).
- `403`: API key lacks the required `platform` scope (`code` PLATFORM_SCOPE_REQUIRED), its lane is invalid (API_KEY_ENVIRONMENT_INVALID), the workspace is not entitled to the platform API (PLATFORM_NOT_ENTITLED), or a supplied `workspaceId` does not match the authenticated workspace (FORBIDDEN).
- `404`: Resource not found, or the /v1 platform is disabled (`code` NOT_FOUND / PARTNER_NOT_FOUND / WORKSPACE_NOT_FOUND).
- `409`: The saved environment is not configured (`code` CONNECTION_ENVIRONMENT_NOT_CONFIGURED), no gateway is bound (GATEWAY_BINDING_REQUIRED), the bound gateway is unavailable (BOUND_GATEWAY_UNAVAILABLE), the connection changed during the test (CONNECTION_CHANGED_DURING_TEST), or the Idempotency-Key was reused with a different body (IDEMPOTENCY_CONFLICT).
- `422`: The saved transport cannot be tested through this endpoint (`code` CONNECTION_TRANSPORT_UNSUPPORTED).
- `429`: Rate limit exceeded (`code` RATE_LIMITED).
- `500`: Unexpected server error (`code` e.g. PARSE_FAILED, VALIDATE_FAILED, OUTBOUND_FAILED, INBOUND_FAILED, BATCH_FAILED, TRANSACTIONS_FAILED, DOCUMENT_RECEIPT_FAILED, DOCUMENT_PAYLOAD_FAILED). Sanitized bodies carry an opaque `correlationId` to quote to support; internal error text is never echoed.

---

[API](https://skmtc.dev/signaledi/apis/signaledi-developer-api.md) · [All operations](https://skmtc.dev/signaledi/apis/signaledi-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signaledi/apis/signaledi-developer-api/revisions/9bc596644a10?raw)