You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: rewrite Arc Cloud docs with correct API endpoints
Replace made-up /api/v1/ingest and /api/v1/sql endpoints with real Arc API:
- MessagePack (/api/v1/write/msgpack) as primary ingestion
- Line protocol (/api/v1/write/line-protocol) for Telegraf/InfluxDB compat
- SQL query (/api/v1/query) with JSON and Arrow response formats
- Bulk import: CSV, Parquet, InfluxDB line protocol migration
New docs:
- Integrations guide (Telegraf, InfluxDB clients, OTEL, Vector, MQTT, SDK)
- Migration guide (InfluxDB, CSV, Parquet import)
Updated: overview pricing, quickstart, all guides, API reference.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Arc Cloud instances expose the same HTTP API as self-hosted Arc. Any Arc client, SDK, or integration that works with Arc will work with Arc Cloud without modification.
7
+
Arc Cloud instances expose the full Arc HTTP API. Any Arc client, SDK, or integration that works with Arc will work with Arc Cloud without modification -- including InfluxDB-compatible endpoints.
8
8
9
9
## Base URL
10
10
@@ -24,65 +24,154 @@ You can find your instance's base URL on the dashboard overview page.
24
24
25
25
## Authentication
26
26
27
-
All API requests (except the health check) require a Bearer token in the `Authorization` header:
27
+
All API requests (except `/health`) require authentication. Arc Cloud supports multiple authentication methods:
28
28
29
+
| Method | Header / Param | Example |
30
+
|--------|---------------|---------|
31
+
| Bearer token (standard) |`Authorization: Bearer TOKEN`| Most clients and SDKs |
curl -X POST "https://abc123.arc.us-east-1.basekick.net/api/v1/import/csv?db=mydb&measurement=sensors&time_column=timestamp" \
140
+
-H "Authorization: Bearer <token>" \
141
+
-H "Content-Type: text/csv" \
142
+
--data-binary @data.csv
143
+
```
144
+
145
+
### Bulk Import (Parquet)
146
+
147
+
```bash
148
+
curl -X POST "https://abc123.arc.us-east-1.basekick.net/api/v1/import/parquet?db=mydb&measurement=sensors" \
149
+
-H "Authorization: Bearer <token>" \
150
+
-H "Content-Type: application/octet-stream" \
151
+
--data-binary @data.parquet
67
152
```
68
153
69
154
## Response Format
70
155
71
-
All API responses return JSON with the following structure:
156
+
JSON query responses (`/api/v1/query`) return the following structure:
72
157
73
158
```json
74
159
{
75
-
"success": true,
76
-
"data": [...],
77
-
"columns": ["column_name", "column_type"]
160
+
"columns": ["time", "host", "usage"],
161
+
"types": ["timestamp", "string", "float64"],
162
+
"data": [
163
+
["2026-03-23T12:00:00Z", "server01", 0.64],
164
+
["2026-03-23T12:00:00Z", "server02", 0.38]
165
+
],
166
+
"row_count": 2,
167
+
"execution_time_ms": 3
78
168
}
79
169
```
80
170
81
171
On error:
82
172
83
173
```json
84
174
{
85
-
"success": false,
86
175
"error": "Description of the error"
87
176
}
88
177
```
@@ -93,6 +182,4 @@ Rate limits vary by tier. When you exceed your tier's ingest rate, the API retur
93
182
94
183
## Full API Documentation
95
184
96
-
The Arc Cloud API is identical to the self-hosted Arc API. For complete endpoint documentation, request/response schemas, and advanced usage, see the [Arc API Reference](/arc/api-reference).
97
-
98
-
Any Arc client or SDK works with Arc Cloud — just point it at your instance's base URL and provide your API token.
185
+
For complete endpoint documentation, request/response schemas, and advanced usage, see the [Arc API Reference](/arc/api-reference).
Arc Cloud automatically creates the database and table on first write.
62
58
59
+
:::tip MessagePack for Production
60
+
Line protocol is convenient for quick tests. For production workloads, use the MessagePack endpoint (`POST /api/v1/write/msgpack`) with columnar format for higher throughput and lower overhead. See the [Arc API Reference](/arc/api-reference) for details.
61
+
:::
62
+
63
63
## 7. Query Your Data
64
64
65
65
Retrieve the data you just ingested:
66
66
67
67
```bash
68
-
curl -X POST https://<instance-id>.arc.<region>.basekick.net/api/v1/sql \
68
+
curl -X POST "https://<your-instance>.arc.us-east-1.basekick.net/api/v1/query" \
69
69
-H "Authorization: Bearer <your-token>" \
70
70
-H "Content-Type: application/json" \
71
-
-d '{"query": "SELECT * FROM my_app.events LIMIT 10"}'
71
+
-d '{"sql": "SELECT * FROM default.events LIMIT 10", "format": "json"}'
72
+
```
73
+
74
+
## 8. Use the Python SDK
75
+
76
+
Arc Cloud exposes the same API as Arc OSS, so all Arc clients and SDKs work without modification. Install the Python SDK:
0 commit comments