Skip to content

Config API edits #7915

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
merged 2 commits into from
Sep 9, 2025
Merged

Config API edits #7915

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebfcc60
config-api edits
rchinn1 Sep 8, 2025
ea93e0b
Apply suggestions from code review
rchinn1 Sep 9, 2025
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
83 changes: 37 additions & 46 deletions src/api/config-api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,72 +6,63 @@ redirect_from:

{% include content/papi-ga.html %}

The Config API enables you to programmatically manage Segment workspaces, sources, destinations and more. With the API you can:
The Config API lets you programmatically manage Segment workspaces, sources, destinations, and more.

* List all your workspace Sources and Destinations to see how data flows through Segment
* Create new Destinations - or delete them - with a few lines of code
* Create new users and assign them to scoped roles
* Configure, disable, or view Sources and manage connected Destinations
* Get a complete view of all the Sources and Destinations available in Segment's catalog
* Configure a Tracking Plan to see how data conforms to your expected schema
* Query Event Delivery metrics to build custom dashboards and alerts to monitor delivery of your events to destinations
* Filter entire events or individual fields from reaching specific destinations
With the Config API, you can:

- List all your workspace sources and destinations to see how data flows through Segment
- Create new destinations - or delete them - with a few lines of code
- Create new users and assign them to scoped roles
- Configure, disable, or view sources and manage connected destinations
- Get a complete view of all the sources and destinations available in Segment's catalog
- Configure a Tracking Plan to see how data conforms to your expected schema
- Query Event Delivery metrics to build custom dashboards and alerts to monitor delivery of your events to destinations
- Filter entire events or individual fields from reaching specific destinations

The Config API is a set of REST services under segmentapis.com:

| Service | Description |
| --------------------------- | ------------------------------------------------------ |
| [Access Tokens][1] | Manage access tokens |
| [Source Catalog][2] | Get info about all event and cloud sources |
| [Destination Catalog][3] | Get info about all destinations |
| [Workspaces][4] | Get info about workspaces |
| [Sources][5] | Manage workspace sources |
| [Destinations][6] | Manage workspace destinations |
| [Tracking Plans][7] | Manage workspace tracking plans |
| [Event Delivery Metrics][8] | Get event delivery metrics for cloud-mode destinations |
| [Destination Filters][9] | Manage destination filters |
| [IAM][10] | Manage workspace users and roles |
| [Functions][11] | Manage Functions |

[1]: https://reference.segmentapis.com/#cd642f96-0fca-42a1-a727-e16fd33c7e8f
[2]: https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8
[3]: https://reference.segmentapis.com/#361ed478-5e53-4835-ab7e-7dbff736524f
[4]: https://reference.segmentapis.com/#7ed2968b-c4a5-4cfb-b4bf-7d28c7b38bd2
[5]: https://reference.segmentapis.com/#5a852761-54d5-46da-8437-6e14e63449f3
[6]: https://reference.segmentapis.com/#39ce0439-0969-48c3-ba49-b22a46c41060
[7]: https://reference.segmentapis.com/#c4647e3c-fe1b-4e2f-88b9-6634841eb4e5
[8]: https://reference.segmentapis.com/#51d89077-efd7-429b-85d4-155ac2cd07aa
[9]: https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5
[10]: https://reference.segmentapis.com/?version=latest#c4b14304-9112-4803-aa26-c08678cbe26a
[11]: https://reference.segmentapis.com/?version=latest#c0866f35-2f39-4dfd-9fd3-26a0003ae74c

To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/).

At this time there are no language-specific clients. However the [API Reference](https://reference.segmentapis.com/) also contains example code snippets for cURL, Go, Node, Python and more.

## Quick Start

You can interact with the API from the command line. First install the `curl` tool.
| [Access Tokens](https://reference.segmentapis.com/#cd642f96-0fca-42a1-a727-e16fd33c7e8f){:target="_blank"} | Manage access tokens |
| [Source Catalog](https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8){:target="_blank"} | Get info about all event and cloud sources |
| [Destination Catalog](https://reference.segmentapis.com/#361ed478-5e53-4835-ab7e-7dbff736524f){:target="_blank"} | Get info about all destinations |
| [Workspaces](https://reference.segmentapis.com/#7ed2968b-c4a5-4cfb-b4bf-7d28c7b38bd2){:target="_blank"} | Get info about workspaces |
| [Sources](https://reference.segmentapis.com/#5a852761-54d5-46da-8437-6e14e63449f3){:target="_blank"} | Manage workspace sources |
| [Destinations](https://reference.segmentapis.com/#39ce0439-0969-48c3-ba49-b22a46c41060){:target="_blank"} | Manage workspace destinations |
| [Tracking Plans](https://reference.segmentapis.com/#c4647e3c-fe1b-4e2f-88b9-6634841eb4e5){:target="_blank"} | Manage workspace tracking plans |
| [Event Delivery Metrics](https://reference.segmentapis.com/#51d89077-efd7-429b-85d4-155ac2cd07aa){:target="_blank"} | Get event delivery metrics for cloud-mode destinations |
| [Destination Filters](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5){:target="_blank"} | Manage destination filters |
| [IAM](https://reference.segmentapis.com/?version=latest#c4b14304-9112-4803-aa26-c08678cbe26a){:target="_blank"} | Manage workspace users and roles |
| [Functions](https://reference.segmentapis.com/?version=latest#c0866f35-2f39-4dfd-9fd3-26a0003ae74c){:target="_blank"} | Manage Functions |


To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/){:target="_blank"}.

At this time there are no language-specific clients. However the [API Reference](https://reference.segmentapis.com/){:target="_blank"} also contains example code snippets for cURL, Go, Node, Python, and more.

## Quick start

You can call the API from the command line. First, install `curl`:

```shell
$ brew install curl
```

### Access Tokens
### Access tokens

You can use the Config API with an access token to programmatically access Segment resources that the token can access. Access tokens are created by workspace owners using the Access Management page, and can only access resources that the token has permission to.
You can use the Config API with an access token to programmatically access Segment resources that the token can access. Access tokens are created by workspace owners using the **Access Management** page, and can only access resources that the token has permission to.

These are currently only suitable for first party, trusted applications, such as your personal local scripts and server side programs. Partners should not prompt Segment users for their username and password and save an access token as a way to delegate access. See the [Authentication](/docs/api/config-api/authentication/) doc for more information.

When you create an access token, you'll give it a description, a workspace, and determine whether it has workspace owner or member access.

> warning "Secret Token"
> warning "Secret token"
> You can not retrieve the plain-text `token` later, so you should save it in a secret manager. If you lose the `token` you can generate a new one.

> info
> As of February 1, 2024, new Config API tokens cannot be created in the app as Segment moves toward exclusive support for the [Public API](/docs/api/public-api/). [Migrate your implementation to the Public API](https://docs.segmentapis.com/tag/Migration){:target="_blank”} to access the latest features and available endpoints. To create a new Config API token, reach out to [email protected] for support.
> info ""
> As of February 1, 2024, new Config API tokens cannot be created in the app as Segment moves toward exclusive support for the [Public API](/docs/api/public-api/). [Migrate your implementation to the Public API](https://docs.segmentapis.com/tag/Migration){:target="_blank”} to access the latest features and available endpoints. To create a new Config API token, [contact Segment](mailto:[email protected]) for support.

### API Requests
### API requests

Now that you have an access token, you can use this token to access the rest of the Config API by setting it in the `Authorization` header of your requests, for example:

Expand Down