Endpoint

/v1/ldap/status

GET

Get LDAP connection status if applicable.

Parameters

This resource has no parameters.

Response

Codes

Code Description
200 Return value on success

Schema

{
  "type": "array",
  "items": {
    "description": "api_ldap_connection_state",
    "type": "object",
    "properties": {
      "node_id": {
        "description": "node_id",
        "type": "number"
      },
      "servers": {
        "type": "array",
        "items": {
          "description": "servers",
          "type": "object",
          "properties": {
            "bind_uri": {
              "description": "bind_uri",
              "type": "string"
            },
            "kdc_address": {
              "description": "kdc_address",
              "type": "string"
            }
          }
        }
      },
      "bind_domain": {
        "description": "bind_domain",
        "type": "string"
      },
      "bind_account": {
        "description": "bind_account",
        "type": "string"
      },
      "base_dn_vec": {
        "type": "array",
        "items": {
          "description": "base_dn_vec",
          "type": "string"
        }
      },
      "health": {
        "type": "string",
        "enum": [
          "NO_RECENT_ERROR",
          "INTERMITTENT_ERROR",
          "SUSTAINED_ERROR"
        ],
        "description": "health:\n * `INTERMITTENT_ERROR` - LDAP_HEALTH_INTERMITTENT_ERROR,\n * `NO_RECENT_ERROR` - LDAP_HEALTH_NO_RECENT_ERROR,\n * `SUSTAINED_ERROR` - LDAP_HEALTH_SUSTAINED_ERROR"
      }
    }
  }
}