@devries-cameron20 / composio Mirror · read-only
Fork 0

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

next
md 162 lines 5.64 KB
Rendered Raw
1 ---
2 type: "reference"
3 title: "Platform Health Endpoints"
4 description: "Public reference for Composio on-prem and self-hosted health endpoints."
5 category: "sessions-and-execution"
6 visibility: "public"
7 timestamp: "2026-06-24T00:00:00Z"
8 tags:
9 - "health-endpoints"
10 ---
11 # Platform Health Endpoints
12
13 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.
14
15 Requests must include the Composio admin token header:
16
17 ```http
18 x-composio-admin-token: <COMPOSIO_ADMIN_TOKEN>
19 ```
20
21 ## Apollo
22
23 ### Basic liveness
24
25 #### Python
26
27 > [!NOTE]
28 > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
29
30 #### TypeScript
31
32 > [!NOTE]
33 > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
34
35 #### API
36
37 <!-- 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." -->
38 <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api/healthz" reason="Apollo's self-hosted liveness route is unversioned." -->
39 <!-- 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." -->
40 ```bash
41 curl -i "$COMPOSIO_BASE_URL/api/healthz" \
42 -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN"
43 ```
44
45 Success:
46
47 ```json
48 {
49 "status": "ok"
50 }
51 ```
52
53 <!-- end-languages -->
54
55 This only confirms that Apollo can serve the request. It does not check downstream dependencies.
56
57 ### Deep dependency health
58
59 #### Python
60
61 > [!NOTE]
62 > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
63
64 #### TypeScript
65
66 > [!NOTE]
67 > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
68
69 #### API
70
71 <!-- 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." -->
72 <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api/deep_healthz" reason="Apollo's self-hosted dependency-health route is unversioned." -->
73 <!-- 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." -->
74 ```bash
75 curl -sS "$COMPOSIO_BASE_URL/api/deep_healthz" \
76 -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" | jq
77 ```
78
79 <!-- end-languages -->
80
81 Example:
82
83 Apollo deep health checks:
84
85 - `postgres`: `SELECT 1` through Prisma.
86
87 - `redis`: Redis `PING`.
88
89 - `thermos`: generated Thermos client `getHealthcheck()`, which calls Thermos `GET /api`.
90
91 - 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.
92
93 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.
94
95 ## Thermos
96
97 ### Basic liveness
98
99 #### Python
100
101 > [!NOTE]
102 > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
103
104 #### TypeScript
105
106 > [!NOTE]
107 > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
108
109 #### API
110
111 <!-- 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." -->
112 <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api" reason="Thermos's self-hosted liveness route is unversioned." -->
113 <!-- 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." -->
114 ```bash
115 curl -i "$THERMOS_BASE_URL/api" \
116 -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN"
117 ```
118
119 Example:
120
121 ```json
122 {
123 "status": "ok",
124 "time": "2026-06-19T05:37:25Z"
125 }
126 ```
127
128 ### Deep dependency health
129
130 #### Python
131
132 > [!NOTE]
133 > The Python SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
134
135 #### TypeScript
136
137 > [!NOTE]
138 > The TypeScript SDK has no resource for self-hosted admin-health endpoints. Use the API option with your deployment URL and admin token.
139
140 #### API
141
142 <!-- 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." -->
143 <!-- code-example: unchecked-api rule="api-legacy-version" operation="GET /api/health/deep" reason="Thermos's self-hosted dependency-health route is unversioned." -->
144 <!-- 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." -->
145 ```bash
146 curl -sS "$THERMOS_BASE_URL/api/health/deep" \
147 -H "x-composio-admin-token: $COMPOSIO_ADMIN_TOKEN" | jq
148 ```
149
150 <!-- end-languages -->
151
152 Example:
153
154 Required services are `database`, `toolkit_registry_database`, and `temporal`.
155
156 Thermos status behavior:
157
158 - `healthy`: required services are not in `error`.
159
160 - `unhealthy`: required service `database`, `toolkit_registry_database`, or `temporal` is in `error`.
161
162 Thermos returns HTTP `503` only when overall status is `unhealthy`; otherwise it returns HTTP `200`.