Skip to content
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

Jump to bottom

Update index.md Creating A Public API Token #6461

Merged
merged 3 commits into from
Apr 30, 2024
Merged

Update index.md Creating A Public API Token #6461

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6ebb146
Update index.md Creating A Public API Token
lizkane222 Apr 29, 2024
0b82f85
Update src/api/public-api/index.md
forstisabella Apr 30, 2024
282069b
Update src/api/public-api/index.md
forstisabella Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions src/api/public-api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ The Public API includes the following benefits over the Config API:
| Available in Europe | The Public API is accessible to both US and EU-based workspaces. | |
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |

## Creating a Public API token
forstisabella marked this conversation as resolved.
Show resolved Hide resolved

> info "Only Workspace Owners can create a Public API token"
> Only users with the Workspace Owner role can create a Public API token. For more information about roles, see Segment's [Roles](/docs/segment-app/iam/roles/) documentation.

To create a Public API token in your Segment workspace:
1. Navigate to Settings > Workspace settings > Access Management > Tokens.
2. Click the **+ Create Token** button.
3. Create a description for the token and assign it either Workspace Owner or Workspace Member access.
4. Click **Create**.
5. Copy your workspace token somewhere secure and click **Done**.

To begin sending requests to the Public API, make sure to include the Public API Token into your HTTP requests with the `Authorization` Header and configured with `Bearer Token` and the value of the newly generated Public API token.


## API Token Security

Expand Down