Skip to content
Nexa Platform Docs

Health check

GET
/api/v1/workspace/health
curl --request GET \
  --url https://example.com/api/v1/workspace/health

Check Databricks Workspace connectivity.

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
WorkspaceHealthCheckResponse

Response model for workspace health check.

object
status
required
Status

Health status (healthy, unhealthy)

string
message
required
Message

Health check message

string
workspace_accessible
required
Workspace Accessible

Whether workspace is accessible

boolean
databricks_connection
required
Databricks Connection

Databricks connection status

string
error
Any of:
string
Examplegenerated
{
  "status": "example",
  "message": "example",
  "workspace_accessible": true,
  "databricks_connection": "example",
  "error": "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"
    }
  ]
}