Skip to content

Commit 37fd273

Browse files
committed
docs: Clarify base_path in the REST API
1 parent 19d1b33 commit 37fd273

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

docs/pages/product/apis-integrations/rest-api/reference.mdx

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,16 @@ redirect_from:
55

66
# REST API reference
77

8-
[REST API][ref-rest-api] provides the following endpoints.
8+
The [REST API][ref-rest-api] provides the following endpoints.
99

10-
## `/v1/load`
10+
<InfoBox>
11+
12+
The `{base_path}` part of the endpoint URLs can be [configured][ref-basepath].
13+
By default, it's `/cubejs-api`.
14+
15+
</InfoBox>
16+
17+
## `{base_path}/v1/load`
1118

1219
Get the data for a query.
1320

@@ -90,7 +97,7 @@ values.
9097

9198
</WarningBox>
9299

93-
## `/v1/sql`
100+
## `{base_path}/v1/sql`
94101

95102
Get the SQL Code generated by Cube to be executed in the database.
96103

@@ -152,7 +159,7 @@ that Cube passes to an underlying data source driver later when executing the qu
152159

153160
</InfoBox>
154161

155-
## `/v1/meta`
162+
## `{base_path}/v1/meta`
156163

157164
Get meta-information for cubes and views defined in the data model. Information about cubes and views with `public: false` will not be returned.
158165

@@ -222,7 +229,7 @@ Example response:
222229
}
223230
```
224231

225-
## `/v1/pre-aggregations/jobs`
232+
## `{base_path}/v1/pre-aggregations/jobs`
226233

227234
Trigger pre-aggregation build jobs or retrieve statuses of such jobs.
228235

@@ -378,13 +385,8 @@ Example response:
378385

379386
## `/readyz`
380387

381-
Returns the ready state of the deployment.
382-
383-
**Single-tenant:** Ensures the orchestration layer is operational and tests the
384-
connection to the default `dataSource`.
385-
386-
**Multi-tenant:** Tests connections per-tenant. If no connections exist, it will
387-
report as successful.
388+
Reports if the deployment has successfully started. To do so, it will try to test
389+
the connection to the _default_ [data source][ref-datasources].
388390

389391
Example of a successful request:
390392

@@ -422,9 +424,8 @@ Keep-Alive: timeout=5
422424

423425
## `/livez`
424426

425-
Returns the liveness state of the deployment. This is confirmed by testing any
426-
existing connections to `dataSource`. If no connections exist, it will report as
427-
successful.
427+
Reports if the deployment is still healthy. This is confirmed by testing any
428+
existing connections to data sources.
428429

429430
Example of a successful response:
430431

@@ -460,6 +461,7 @@ Keep-Alive: timeout=5
460461
{"health":"DOWN"}
461462
```
462463

463-
[ref-recipes-data-blending]:
464-
/product/data-modeling/concepts/data-blending#data-blending
464+
[ref-recipes-data-blending]: /product/data-modeling/concepts/data-blending#data-blending
465465
[ref-rest-api]: /product/apis-integrations/rest-api
466+
[ref-basepath]: /product/apis-integrations/rest-api#base-path
467+
[ref-datasources]: /product/configuration/advanced/multiple-data-sources

0 commit comments

Comments
 (0)