Skip to content

Commit

Permalink
docs: remove alpha feature nature from C8 Query API
Browse files Browse the repository at this point in the history
  • Loading branch information
@tmetzke
tmetzke committed Dec 12, 2024
1 parent dba4b16 commit f042ba3
Showing 1 changed file with 0 additions and 13 deletions.
13 changes: 0 additions & 13 deletions docs/apis-tools/camunda-api-rest/camunda-api-rest-overview.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,4 @@ spring.servlet.multipart.max-request-size=4MB

For example, if you increase the `maxMessageSize` to 10MB, increase these property values to 10MB as well.

### Query API

:::warning
Query API endpoints do not currently support [resource authorizations][], and can be used to expand user access to restricted resources. If you use resource permissions, allowing public access to those endpoints is not recommended.
:::

All Query API endpoints contain an `(alpha)` declaration. Those endpoints are not accessible by default in Camunda 8 clusters.

You can enable the [alpha feature][] search endpoints by setting either the configuration property `camunda.rest.query.enabled` to `true`,
or the environment variable `CAMUNDA_REST_QUERY_ENABLED` to `true`.

[camunda-api-explorer]: ./specifications/camunda-8-rest-api.info.mdx
[resource authorizations]: /self-managed/concepts/access-control/resource-authorizations.md
[alpha feature]: /components/early-access/alpha/alpha-features.md

0 comments on commit f042ba3

Please sign in to comment.