Skip to content
Nexa Platform Docs

Test Snowflake Connection

POST
/api/v1/auth/test-connection
curl --request POST \
  --url https://example.com/api/v1/auth/test-connection

Test Snowflake connection using configured credentials.

This endpoint validates connectivity using environment settings.

Returns: ConnectionTestResponse with connection test results

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ConnectionTestResponse

Response model for connection test.

object
success
required
Success

Whether connection was successful

boolean
message
required
Message

Connection test message

string
snowflake_version
Any of:
string
account
required
Account

Snowflake account

string
user
required
User

Snowflake user

string
warehouse
required
Warehouse

Snowflake warehouse

string
Examplegenerated
{
  "success": true,
  "message": "example",
  "snowflake_version": "example",
  "account": "example",
  "user": "example",
  "warehouse": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}