Learning Outcomes
- Understanding the capabilities of the Foundry Connect API.
- Steps for getting started with API authentication and usage.
- Examples of practical applications of the API.
Introduction to the Foundry Connect API
The Foundry Connect API serves as a comprehensive interface enabling developers to programmatically interact with the Foundry Connect platform. It facilitates the management of configurations, projects, workspaces, user accounts, pipelines, and more. This API is crafted based on the OpenAPI Specification (OAS) 3.1, ensuring clarity and compatibility with diverse tools and libraries.
Key Features
| Feature Category | Key Features |
|---|---|
| Configurations | - Retrieve both platform-wide and user-specific configurations. - Access application change logs for monitoring updates. |
| Project Management | - Create, update, and delete projects. - Manage project pipelines, runs, and associated metadata. |
| Workspace Management | - Create and manage workspaces and their assets. |
| Authentication | - Supports multiple authentication mechanisms. - Personal access tokens, OAuth (Google/GitHub), and SAML. - Include functionalities for password reset, logout, and token generation. |
| Data Operations | - Handle datasets, files, and data across platforms. - Manage catalog assets for organized data handling. |
| Pipeline and Process Management | - List, create, and update pipelines and processes. - Manage revisions of pipelines and duplicate processes. |
| User Management | - Handle user credentials, service tokens, and group management. - Track user activity effectively. |
| Run Management | - Initiate and track runs. - Retrieve details, logs, and reports for individual runs. |
| Assistance and Tools | - Utilize code generation tools for specific prompts and languages. - Manage feature flags either globally or on a user-specific basis. |
Path convention
Every endpoint is served under:
/api/v1/<resource>
Use that form for anything you write.
You will also see an older /api/<resource>/v1 style in existing code and in some
stored examples. Both reach the same handler and the older form still works, so nothing
you have today breaks. It is simply no longer the documented style, and new resources
are added only under /api/v1/<resource>.
Two exceptions, both deliberate and both permanent:
/api/oauth/v1/...keeps its shape. Those URLs are published in the OAuth discovery metadata (RFC 8414) and are baked into already-registered clients, so moving them would break integrations that cannot be updated on our schedule./.well-known/...sits at the site root rather than under/api, because clients probe those paths against the server origin.
First steps
Authorization
/api/v1/auth/personal-access-token
Many API endpoints necessitate authentication via personal access tokens or OAuth. Begin by generating a token using the personal-access-token endpoint.
Explore API Endpoints
/api/v1/configurations
Use /api/v1/configurations to initiate interaction with platform configurations.
/api/v1/project
Manage projects through the /api/v1/project endpoint.
/api/v1/run
Initiate runs and access pipeline data via /api/v1/run.
Interactive Documentation
Access the interactive Swagger UI at Foundry Connect API Docs to test endpoints and review detailed request/response schemas.
Support and Feedback
For support refer to our API documentation available at:
<your instance>/api-docs/#/
Additionally, please feel free to contact biocore@umassmed.edu with questions and/or feedback.