Add an API to a gateway
Adding an API to a gateway makes its operations callable through the environment you are on. You choose which version of the API is served, which of its connections the gateway can reach, and how a call picks one.
Before you begin
- The API's analysis has finished.
- The API has at least one connection. See Add a connection.
Add the API
To add an API:
- In the portal, go to Agent Gateway and select your gateway.
- Check the environment button in the header. The API is added to the environment it names.
- Select the APIs tab, then Add existing API.
- Under API, select the API.
- Under Version, select Latest or a version number.
- Latest follows every version you publish.
- A numbered version stays until you change it.
- Under Connections, select the connections this gateway can reach, then select Continue.
- Under Routing, select Fixed, Dynamic or Fan-out. With one connection, every call goes to it. See Routing: fixed, dynamic and fan-out.
- Select Add API to gateway.
The API appears in the APIs tab with its version and routing. Its operations are exposed, and clients can call them immediately. Recipes and deprecated operations start hidden. To hide some, see Choose which operations are exposed.
To analyze a new API from this screen, select New API. The wizard brings you back to the gateway when the analysis finishes.
Change the version, routing or connections
To change how a gateway serves an API:
- In the APIs tab, select the API.
- Change Served version under Version, the routing under Mode, or the connections under In play.
- Select Save changes.
A pinned version does not receive new publishes. The gateway keeps serving the operations, schemas and recipes of that version until you move it.
Remove an API from a gateway
On the same page, Remove from gateway stops serving the API in this environment. Its operations disappear from the gateway immediately, and keys and users scoped to them lose that scope. The API and its connections stay in APIs.
Troubleshooting
| Symptom | Cause | Fix |
|---|---|---|
| The Connections step says "This API has no connection yet" | The API has no connection. | Add one in the API's Connections tab, then start again. |
| A change to an operation does not reach the gateway | The gateway serves a pinned version, or the change is in the API's draft. | Publish the API, and set Served version to Latest or to the new version. |
Next steps
- Choose which operations are exposed: hide operations in this environment.
- Routing: fixed, dynamic and fan-out: what each routing mode does.
- Connections: where an API's endpoint and credentials live.
Last updated November 13, 2026