API proxy - Atlan Documentation

6 operations on client.apis. Path parameters come first, positionally; the request body is last, as a plain object. Method names are snake_case in Python and camelCase in TypeScript, and resource names follow the same rule.

path must be a single segment. Both SDKs percent-encode a / inside it, and the gateway refuses an encoded separator with 400 path_not_allowed. These methods also send no request body and no query string. For a multi-segment path, a body, or a query string, call /api/v1/apis/{api_id}/<path> over HTTP instead. Every proxy call needs member or admin on the API’s workspace; viewer is refused.

result = client.apis.proxy_delete(api_id, path)

const result = await client.apis.proxyDelete(api_id, path);

Operations

Call	Route	Does
`client.apis.proxy_delete(api_id, path)`	`DELETE /api/v1/apis/{api_id}/{path}`	Proxy a request to a registered API
`client.apis.proxy_get(api_id, path)`	`GET /api/v1/apis/{api_id}/{path}`	Proxy a request to a registered API
`client.apis.proxy_head(api_id, path)`	`HEAD /api/v1/apis/{api_id}/{path}`	Proxy a request to a registered API
`client.apis.proxy_patch(api_id, path)`	`PATCH /api/v1/apis/{api_id}/{path}`	Proxy a request to a registered API
`client.apis.proxy_post(api_id, path)`	`POST /api/v1/apis/{api_id}/{path}`	Proxy a request to a registered API
`client.apis.proxy_put(api_id, path)`	`PUT /api/v1/apis/{api_id}/{path}`	Proxy a request to a registered API

How the client is organised

Resources, call shapes, and errors.

Errors and retries

What the SDK raises, and which calls are safe to retry.

​Operations

​Related

How the client is organised

Errors and retries

Operations

Related