---
title: "Test a connection"
method: GET
path: "/v2/connections/{connectionId}/test"
tags: ["Connections"]
---

# Test a connection

`GET /v2/connections/{connectionId}/test`

## Request

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

Test whether an existing connection allows read and write operations for the user associated with the API credentials.

  ### Usage notes
  - Retrieve the **connectionId** by calling the [/v2/connections](https://help.sigmacomputing.com/reference/list-connections) endpoint.

## Path parameters

- `connectionId` string, required

## Response `200`

The response body.

- ConnectionsTestConnectionResponse200
  - `read` union, required
    - 'SUCCESS'
    - 'FAILED'
  - `write` union, required
    - 'DISABLED'
    - 'SUCCESS'
    - 'FAILED'

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)