Publishing an API Collection
Publishing makes a collection available to consumers and generates its OpenAPI specification. Until a collection is published it exists only as a definition — its endpoints cannot be called through API Manager.
Before you begin
- The collection must already exist. See Creating an API Collection.
- Confirm the endpoints in Added Endpoints are the ones you intend to expose. Publishing exposes every endpoint in the collection.
Publish the collection
- Open API Manager > API Collections.
- Select the collection name to open it.
- Review the endpoints listed under Added Endpoints.
- Select Publish to Manager.
How you know it worked
Studio confirms with Your collection was published successfully, and the collection's status changes from NOT PUBLISHED to PUBLISHED on the API Collections page. The Published at and Published by details are recorded against it.
The collection's OpenAPI Specification becomes available from the collection, and the collection appears under Published APIs.
When it does not work
| Symptom | Cause | What to do |
|---|---|---|
| Status stays NOT PUBLISHED | The publish action did not complete | Reopen the collection and select Publish to Manager again |
| An expected endpoint is missing from the published API | The path was never added to the collection | Update the collection to add the path, then republish |
| A published endpoint returns an error when called | The underlying workflow is no longer deployed | Redeploy the workflow, then republish the collection |
Next steps
- View published collections to confirm what consumers can see.
- Create client profiles to grant and manage access.
- Create mock API endpoints so consumers can integrate before the real implementation is ready.