Skip to content

Commit fba1b07

Browse files
bobbyatsegmentmarkzegarelli
andauthored
Update Public API docs to highlight eligibility for PAPI access (#4036)
* Update index.md * Add plan grid to Public API page Co-authored-by: markzegarelli <[email protected]>
1 parent de7e4d3 commit fba1b07

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

src/_data/products.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,3 +145,12 @@ items:
145145
team: false
146146
business: true
147147
add-on: false
148+
149+
- product_display_name: Public API
150+
slug: papi
151+
plan-note: "The Public API is available to customers on Team or Business plans."
152+
plans:
153+
free: false
154+
team: true
155+
business: true
156+
add-on: false

src/api/public-api/index.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
---
22
title: Public API
3+
plan: papi
34
---
4-
The Segment Public API helps you manage your Segment workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs.
5+
The Segment Public API helps you manage your Segment workspaces and its resources. You can use the API to perform CRUD (create, read, update, delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. The Public API is available to Team and Business Tier customers.
56

67
All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a workspace.
78

@@ -26,6 +27,7 @@ The Public API includes the following benefits over the Config API:
2627
| Available in Europe | The Public API is accessible to both US and EU-based workspaces. |
2728
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate |
2829

30+
2931
## API Token Security
3032

3133
To enhance API token security, Segment partners with GitHub to prevent fraudulent use of exposed API tokens found in public git repositories. This helps to prevent malicious actors from using exposed tokens to perform unauthorized actions in your Segment workspace.
@@ -45,4 +47,5 @@ Developers can accidentally commit tokens to public repositories, exposing them
4547
By automatically revoking the exposed token, Segment helps keep your workspace secure and prevents potential abuse of the token.
4648

4749
#### How do I enable this feature?
48-
This feature is automatically enabled for all workspaces on Team or Business tier plans.
50+
This feature is automatically enabled for all workspaces on Team or Business tier plans.
51+

0 commit comments

Comments
 (0)