mixpeek.HealthApi

All URIs are relative to https://api.mixpeek.com

Method	HTTP request	Description
celery_beat_health	GET /v1/health/beat	Celery Beat Health
celery_beat_health_0	GET /v1/health/beat	Celery Beat Health
healthcheck_health	GET /v1/health	Healthcheck
healthcheck_health_0	GET /v1/health	Healthcheck
liveness_health	GET /v1/health/liveness	Liveness
liveness_health_0	GET /v1/health/liveness	Liveness

celery_beat_health

object celery_beat_health()

Celery Beat Health

Check if Celery Beat scheduler is running.

Reads the heartbeat timestamp from Redis (written every 60s by beat). Returns unhealthy if heartbeat is older than 5 minutes.

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.HealthApi(api_client)

    try:
        # Celery Beat Health
        api_response = api_instance.celery_beat_health()
        print("The response of HealthApi->celery_beat_health:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->celery_beat_health: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

celery_beat_health_0

object celery_beat_health_0()

Celery Beat Health

Check if Celery Beat scheduler is running.

Reads the heartbeat timestamp from Redis (written every 60s by beat). Returns unhealthy if heartbeat is older than 5 minutes.

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.HealthApi(api_client)

    try:
        # Celery Beat Health
        api_response = api_instance.celery_beat_health_0()
        print("The response of HealthApi->celery_beat_health_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->celery_beat_health_0: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthcheck_health

HealthCheckResponse healthcheck_health(deep=deep, metrics=metrics)

Healthcheck

Health check endpoint.

Example

import mixpeek
from mixpeek.models.health_check_response import HealthCheckResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.HealthApi(api_client)
    deep = False # bool |  (optional) (default to False)
    metrics = False # bool | Include Layer 2 protection metrics (optional) (default to False)

    try:
        # Healthcheck
        api_response = api_instance.healthcheck_health(deep=deep, metrics=metrics)
        print("The response of HealthApi->healthcheck_health:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->healthcheck_health: %s\n" % e)

Parameters

Name	Type	Description	Notes
deep	bool		[optional] [default to False]
metrics	bool	Include Layer 2 protection metrics	[optional] [default to False]

Return type

HealthCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

healthcheck_health_0

HealthCheckResponse healthcheck_health_0(deep=deep, metrics=metrics)

Healthcheck

Health check endpoint.

Example

import mixpeek
from mixpeek.models.health_check_response import HealthCheckResponse
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.HealthApi(api_client)
    deep = False # bool |  (optional) (default to False)
    metrics = False # bool | Include Layer 2 protection metrics (optional) (default to False)

    try:
        # Healthcheck
        api_response = api_instance.healthcheck_health_0(deep=deep, metrics=metrics)
        print("The response of HealthApi->healthcheck_health_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->healthcheck_health_0: %s\n" % e)

Parameters

Name	Type	Description	Notes
deep	bool		[optional] [default to False]
metrics	bool	Include Layer 2 protection metrics	[optional] [default to False]

Return type

HealthCheckResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
422	Validation Error	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

liveness_health

object liveness_health()

Liveness

Lightweight liveness probe for container orchestration (Render, K8s).

This endpoint returns immediately without checking external services. Use this for Render health checks to avoid timeouts when services are slow.

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.HealthApi(api_client)

    try:
        # Liveness
        api_response = api_instance.liveness_health()
        print("The response of HealthApi->liveness_health:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->liveness_health: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

liveness_health_0

object liveness_health_0()

Liveness

Lightweight liveness probe for container orchestration (Render, K8s).

This endpoint returns immediately without checking external services. Use this for Render health checks to avoid timeouts when services are slow.

Example

import mixpeek
from mixpeek.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.mixpeek.com
# See configuration.py for a list of all supported configuration parameters.
configuration = mixpeek.Configuration(
    host = "https://api.mixpeek.com"
)


# Enter a context with an instance of the API client
with mixpeek.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = mixpeek.HealthApi(api_client)

    try:
        # Liveness
        api_response = api_instance.liveness_health_0()
        print("The response of HealthApi->liveness_health_0:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling HealthApi->liveness_health_0: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

object

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
404	Not Found	-
500	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

HealthApi.md

Latest commit

History

HealthApi.md

File metadata and controls

mixpeek.HealthApi

celery_beat_health

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

celery_beat_health_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthcheck_health

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

healthcheck_health_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

liveness_health

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

liveness_health_0

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details