Skip to content

Correct disable_auth default to true #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonoirwinrsa merged 1 commit into from
Aug 17, 2026
+8 −2
Merged

Correct disable_auth default to true #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion endpoints/inference-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "REST API"
description: "Make authenticated HTTP requests to your Cerebrium endpoints"
---

All functions on Cerebrium are accessible via authenticated POST requests by default, unless marked private by prefixing the function name with an underscore (e.g. `_private_function()`). Authenticate using the JWT token from the **API Keys** section of the dashboard.
All functions on Cerebrium are accessible via POST requests, unless marked private by prefixing the function name with an underscore (e.g. `_private_function()`). Authenticate using the JWT token from the **API Keys** section of the dashboard. Endpoints require this token only when `cerebrium.toml` sets [`disable_auth = false`](/toml-reference/toml-reference) — authentication is disabled by default.

## Request format

Expand Down
8 changes: 7 additions & 1 deletion toml-reference/toml-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The `[cerebrium.deployment]` section defines core deployment settings.
| --------------------------------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------ |
| name | string | required | Desired app name |
| python_version | string | "3.12" | Python version to use (3.10, 3.11, 3.12) |
| disable_auth | boolean | false | Disable default token-based authentication on app endpoints |
| disable_auth | boolean | true | Disable token-based authentication on app endpoints |
| include | string[] | ["*"] | Files/patterns to include in deployment |
| exclude | string[] | [".*"] | Files/patterns to exclude from deployment |
| shell_commands | string[] | [] | Commands to run at the end of the build |
Expand All @@ -28,6 +28,12 @@ The `[cerebrium.deployment]` section defines core deployment settings.
| use_uv | boolean | false | Use UV for faster Python package installation |
| deployment_initialization_timeout | integer | 600 (10 minutes) | The max time to wait for app initialisation during build before timing out. Value must be between 60 and 830 |

<Warning>
`disable_auth` defaults to `true`, so omitting it leaves app endpoints
callable without a token. Set `disable_auth = false` to require the JWT token
described in the [REST API reference](/endpoints/inference-api).
</Warning>

<Info>
Changes to python_version or docker_base_image_url trigger full rebuilds since
they affect the base environment.
Expand Down
Loading