Skip to main content
POST
Test Workspace Connection

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Alternatively, you can authenticate with a personal access token (PAT) by sending Authorization: Basic base64(email:PAT).

Scopes

management:workspaces:write

Write access to workspace resources.

Path Parameters

id
string<uuid>
required

Workspace identifier (UUID).

connection_id
string<uuid>
required

Connection identifier (UUID).

Response

OK

status
enum<string>

Updated connection status. active if the test passed, or error if it failed.

Available options:
active,
error
test_results
object[]

Ordered list of per-check results.

Last modified on November 12, 2026