Skip to content

docs: reference environment key and auth #6475

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
Holmus merged 1 commit into from
Jan 6, 2026
Merged

docs: reference environment key and auth #6475

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 docs/docs/edge-api/Overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar_label: Overview

The Edge API is designed to be publicly accessible. Calls need to have an environment key supplied with each request.
This is provided as an HTTP header, with the name `X-Environment-Key` and the value of the Environment Key that you can
find within the Flagsmith administrative area.
find within the Flagsmith administrative area. See [Flags API Authentication](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) for more details.

## Core API

Expand Down
2 changes: 1 addition & 1 deletion ...s/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Authentication
sidebar_label: Authentication
---

The Flags API uses a non-secret **Environment Key** for authentication. This key is safe to be exposed in public, client-side applications.
The Flags API uses a non-secret **Environment Key** for authentication. This key is safe to be exposed in public, client-side applications. See [Integration Approaches](/best-practices/integration-approaches#client-side-sdk-flag-endpoints-are-public) for security best practices when using client-side keys.

## Finding Your Environment Key

Expand Down
2 changes: 1 addition & 1 deletion ...cs/integrating-with-flagsmith/flagsmith-api-overview/flags-api/code-examples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Code Examples
sidebar_label: Code Examples
---

Here are some `curl` examples demonstrating how to interact directly with the Flags API.
Here are some `curl` examples demonstrating how to interact directly with the Flags API. See [Authentication](/integrating-with-flagsmith/flagsmith-api-overview/flags-api/authentication) for details on how to obtain and use your Environment Key.

### Get Environment Flags

Expand Down