domino_admin_toolkit.checks.test_domino_api_endpoints module

pydantic model domino_admin_toolkit.checks.test_domino_api_endpoints.ApiEndpointsAnalyzer

Bases: AnalyzerBase

Validates Domino API endpoints meet availability and response requirements.

Evaluates:

  • HTTP response status codes (expects 200)

  • JSON response validity

  • Endpoint accessibility and authentication

Fields:
field expected_status_code: int = 200

Expected HTTP status code

analyze(data)

Analyze Domino API endpoints health data.

Return type:

list[CheckResult]

Args:

data: DataFrame containing API endpoint check results with columns:

  • endpoint: The API endpoint that was tested

  • status_code: HTTP status code from the response

  • is_valid_json: Boolean indicating if response was valid JSON

  • error_message: Error message if any issues occurred

Returns:

List of CheckResult objects indicating endpoint health

name: ClassVar[str] = 'ApiEndpointsAnalyzer'
domino_admin_toolkit.checks.test_domino_api_endpoints.api_endpoints_data()

Retrieves API endpoint health data from Domino API using authenticated client

domino_admin_toolkit.checks.test_domino_api_endpoints.test_domino_api_endpoints(api_endpoints_data)

Validates Domino API endpoint availability by testing critical dataset and snapshot endpoints.

This check runs within the Kubernetes cluster to verify internal API connectivity and health.

Failure Conditions:

  • API endpoints return non-200 HTTP status codes

  • Endpoints return invalid JSON responses

  • API authentication or authorization failures

  • Network connectivity issues to nucleus-frontend services

Troubleshooting Steps:

  1. Check nucleus-frontend pod status and recent logs for errors

  2. Verify if other toolkit checks show related service failures

  3. Review platform service health indicators in monitoring dashboards

Resolution Guidance:

  1. If logs show authentication errors, restart the nucleus-frontend deployment

  2. If connectivity issues persist, check network policies and service configurations

  3. Run additional toolkit checks to identify dependencies that may be affecting API services

  4. Contact Domino support if API failures continue after service restart