Update an API Collection
Update a collection when you need to add or remove endpoints, or change its details. Changes are saved to the collection immediately, but consumers do not receive them until you republish.
Before you begin
- Adding an endpoint requires the workflow that owns it to be deployed.
- Removing an endpoint from a published collection withdraws it from consumers once you republish. Confirm nothing depends on it first.
Update the collection
- Open API Manager > API Collections.
- Select the collection name to open it.
- Select Edit.
- Make your changes:
- To change the collection details, edit the Collection Name, Version, or description.
- To add endpoints, select a Workflow under Choose Paths, select the paths, then select Add.
- To remove an endpoint, remove it from Added Endpoints.
- Select Update.
Republish the collection
Saving an update does not republish it. A previously published collection continues to serve its last published state until you republish.
- Select Publish to Manager.
How you know it worked
Studio confirms the save with Collection Updated Successfully. After republishing, Studio confirms with Your collection was published successfully and the Published at timestamp updates.
Open the collection's OpenAPI Specification to confirm your changes are reflected in what consumers receive.
When it does not work
| Symptom | Cause | What to do |
|---|---|---|
| Consumers still receive the previous endpoints | The collection was updated but not republished | Select Publish to Manager |
| Collection name already exists! | The new name is taken by another collection | Choose a different name |
| Failed to save the collection | The update did not persist | Reopen the collection, confirm your changes are absent, and reapply them |
Next steps
- View published collections to confirm the published state.