Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 06:00 UTC
| 1 | Use this only for Composio on-prem / self-hosted customers who ask whether they can monitor their Composio instance in real time. These endpoints are not general public-cloud customer endpoints. |
| 2 | |
| 3 | Requests must include the Composio admin token header: |
| 4 | |
| 5 | ```http |
| 6 | x-composio-admin-token: <COMPOSIO_ADMIN_TOKEN> |
| 7 | ``` |
| 8 | |
| 9 | ## Apollo |
| 10 | |
| 11 | ### Basic liveness |
| 12 | |
| 13 | #### Python |
| 14 | |
| 15 | > [!NOTE] |
| 16 | > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 17 | |
| 18 | #### TypeScript |
| 19 | |
| 20 | > [!NOTE] |
| 21 | > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 22 | |
| 23 | #### API |
| 24 | |
| 25 | <!-- code-example: unchecked-api rule="api-base-url" operation="GET /api/healthz" reason="Apollo health runs at the customer's self-hosted deployment URL, not the public-cloud API." --> |
| 26 | <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api/healthz" reason="Apollo's self-hosted liveness route is unversioned." --> |
| 27 | <!-- code-example: unchecked-api rule="api-key-header" operation="GET /api/healthz" reason="Self-hosted health uses x-composio-admin-token, not a project API key." --> |
| 28 | ```bash |
| 29 | curl -i "$COMPOSIO_BASE_URL/api/healthz" \ |
| 30 | -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" |
| 31 | ``` |
| 32 | |
| 33 | Success: |
| 34 | |
| 35 | ```json |
| 36 | { |
| 37 | "status": "ok" |
| 38 | } |
| 39 | ``` |
| 40 | |
| 41 | <!-- end-languages --> |
| 42 | |
| 43 | This only confirms that Apollo can serve the request. It does not check downstream dependencies. |
| 44 | |
| 45 | ### Deep dependency health |
| 46 | |
| 47 | #### Python |
| 48 | |
| 49 | > [!NOTE] |
| 50 | > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 51 | |
| 52 | #### TypeScript |
| 53 | |
| 54 | > [!NOTE] |
| 55 | > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 56 | |
| 57 | #### API |
| 58 | |
| 59 | <!-- code-example: unchecked-api rule="api-base-url" operation="GET /api/deep_healthz" reason="Apollo health runs at the customer's self-hosted deployment URL, not the public-cloud API." --> |
| 60 | <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api/deep_healthz" reason="Apollo's self-hosted dependency-health route is unversioned." --> |
| 61 | <!-- code-example: unchecked-api rule="api-key-header" operation="GET /api/deep_healthz" reason="Self-hosted health uses x-composio-admin-token, not a project API key." --> |
| 62 | ```bash |
| 63 | curl -sS "$COMPOSIO_BASE_URL/api/deep_healthz" \ |
| 64 | -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" | jq |
| 65 | ``` |
| 66 | |
| 67 | <!-- end-languages --> |
| 68 | |
| 69 | Example: |
| 70 | |
| 71 | Apollo deep health checks: |
| 72 | |
| 73 | - `postgres`: `SELECT 1` through Prisma. |
| 74 | |
| 75 | - `redis`: Redis `PING`. |
| 76 | |
| 77 | - `thermos`: generated Thermos client `getHealthcheck()`, which calls Thermos `GET /api`. |
| 78 | |
| 79 | - active object storage backend: response key is either `s3` or `azure_blob_storage`; Apollo writes a zero-byte probe object and deletes it best-effort. |
| 80 | |
| 81 | Important: Apollo deep health returns HTTP `200` for GET requests even when one or more dependencies are unreachable. Monitors should inspect `data.<service>.reachable`, not just HTTP status. |
| 82 | |
| 83 | ## Thermos |
| 84 | |
| 85 | ### Basic liveness |
| 86 | |
| 87 | #### Python |
| 88 | |
| 89 | > [!NOTE] |
| 90 | > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 91 | |
| 92 | #### TypeScript |
| 93 | |
| 94 | > [!NOTE] |
| 95 | > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 96 | |
| 97 | #### API |
| 98 | |
| 99 | <!-- code-example: unchecked-api rule="api-base-url" operation="GET /api" reason="Thermos health runs at the customer's self-hosted deployment URL, not the public-cloud API." --> |
| 100 | <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api" reason="Thermos's self-hosted liveness route is unversioned." --> |
| 101 | <!-- code-example: unchecked-api rule="api-key-header" operation="GET /api" reason="Self-hosted health uses x-composio-admin-token, not a project API key." --> |
| 102 | ```bash |
| 103 | curl -i "$THERMOS_BASE_URL/api" \ |
| 104 | -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" |
| 105 | ``` |
| 106 | |
| 107 | Example: |
| 108 | |
| 109 | ```json |
| 110 | { |
| 111 | "status": "ok", |
| 112 | "time": "2026-06-19T05:37:25Z" |
| 113 | } |
| 114 | ``` |
| 115 | |
| 116 | ### Deep dependency health |
| 117 | |
| 118 | #### Python |
| 119 | |
| 120 | > [!NOTE] |
| 121 | > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 122 | |
| 123 | #### TypeScript |
| 124 | |
| 125 | > [!NOTE] |
| 126 | > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token. |
| 127 | |
| 128 | #### API |
| 129 | |
| 130 | <!-- code-example: unchecked-api rule="api-base-url" operation="GET /api/health/deep" reason="Thermos health runs at the customer's self-hosted deployment URL, not the public-cloud API." --> |
| 131 | <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api/health/deep" reason="Thermos's self-hosted dependency-health route is unversioned." --> |
| 132 | <!-- code-example: unchecked-api rule="api-key-header" operation="GET /api/health/deep" reason="Self-hosted health uses x-composio-admin-token, not a project API key." --> |
| 133 | ```bash |
| 134 | curl -sS "$THERMOS_BASE_URL/api/health/deep" \ |
| 135 | -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" | jq |
| 136 | ``` |
| 137 | |
| 138 | <!-- end-languages --> |
| 139 | |
| 140 | Example: |
| 141 | |
| 142 | Required services are `database`, `toolkit_registry_database`, and `temporal`. |
| 143 | |
| 144 | Thermos status behavior: |
| 145 | |
| 146 | - `healthy`: required services are not in `error`. |
| 147 | |
| 148 | - `unhealthy`: required service `database`, `toolkit_registry_database`, or `temporal` is in `error`. |
| 149 | |
| 150 | Thermos returns HTTP `503` only when overall status is `unhealthy`; otherwise it returns HTTP `200`. |