Per-connector health metrics and fleet summary

GET

/v1/connectors/health

curl --request GET \
  --url https://example.com/v1/connectors/health \
  --header 'Authorization: Bearer <token>'

• this engine

Returns per-connector health metrics and the fleet summary, compositing the live source roster status with the connector catalog metadata.

Authorizations

• bearerAuth
• browserSession

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Responses

200

OK

Media type application/json

object

items

required

Array<object>

object

avg_latency_ms

integer format: int64

enabled

required

boolean

error_count_24h

integer

health_state

string

kind

required

string

last_polled_at

string format: date-time

name

required

string

poll_seconds

integer

source_mode

string

Allowed values: export live

status

required

string

Allowed values: running failed stopped disabled

tenant

string

title

string

trend

string

summary

required

object

disabled

integer

failed

integer

running

integer

stopped

integer

total

integer

timestamp

required

string format: date-time

Example

{
  "items": [
    {
      "source_mode": "export",
      "status": "running"
    }
  ]
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "module": "example"
  }
}