Skip to main content
The HTTP API proxy forwards a request to a registered API’s base URL and injects its linked credential. Your application keeps the source API’s paths and request shape. You need a registered API, permission to use its workspace, and the source API’s own request documentation. A workspace Builder or Admin can make proxy calls; Viewer access alone does not permit spending its credential.

​
Call a read-only route

  1. Obtain the registered API’s api_id and confirm its base URL and credential with the workspace owner.
  2. Select a read-only route from the source API’s documentation.
  3. Append that relative route after /api/v1/apis/<api-id>/. Send your Atlan bearer token to the gateway.
The example assumes the source API exposes /status. Replace it with a route that API actually documents. The gateway forwards your request to the registered base URL, injects the configured upstream credential, and returns the upstream response. Your Atlan bearer token is not forwarded upstream.

​
Constraints

The API and its linked credential must be in the same workspace. Archived APIs and archived credentials cannot be used. The destination is checked against network restrictions; private and metadata addresses are blocked. This proxy does not import an OpenAPI document or create a per-operation tool catalog. It does not add MCP tools for an arbitrary HTTP API. Use a remote MCP server when the agent needs MCP tools. See the HTTP API reference for the proxy methods and parameters.