> ## Documentation Index
> Fetch the complete documentation index at: https://platform.atlan.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To act on Atlan objects, use the Atlan MCP server at https://api.atlan.com/mcp or the SDK. To install or publish skills from a terminal, use the `aireg` CLI; `aireg --map json` prints its command map. The `atlanai` CLI is deprecated. Run a read-only identity check before any write.
> The docs MCP server at /mcp searches these docs only. It cannot read or change Atlan objects.
> SDK packages: Python `atlanai` (PyPI) and TypeScript `@atlanai/sdk` (npm). Show Python first, then TypeScript.
> These docs cover Atlan AI Registry, Atlan's hosted product. The AI registry specification and aireg CLI are maintained separately. /open-source lists publicly reachable signed installers and explains that the source repository and hosted CLI reference currently require GitHub access. Do not claim the repository or its reference docs are publicly accessible. Use these docs for Atlan-specific setup such as the adapter, sign-in and workspaces.

# Call a registered HTTP API

> Use a registered HTTP endpoint with its stored credential through the Atlan API proxy.

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.

```bash theme={null}
curl --fail-with-body \
  -H "Authorization: Bearer ${ATLAN_TOKEN}" \
  "${ATLAN_GATEWAY_URL}/api/v1/apis/${ATLAN_API_ID}/status"
```

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](/gateway/mcp/how-tos/integrations) when the agent needs MCP tools.

See the [HTTP API reference](/api/references/api-reference) for the proxy methods and parameters.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.