Skip to main content

Interface: AIGatewayClientOptions

Defined in: src/ai-gateway/client.ts:37

Options for constructing an AIGatewayClient.

Properties​

inference?​

optional inference?: AIGatewayInferenceClientOptions;

Defined in: src/ai-gateway/client.ts:39

Separate runtime endpoint/key configuration, resolved lazily when inference is accessed.

clientId?​

optional clientId?: string;

Defined in: src/ai-gateway/client.ts:41

OAuth2 client ID. Falls back to PANW_AI_GW_CLIENT_ID, then PANW_MGMT_CLIENT_ID.

clientSecret?​

optional clientSecret?: string;

Defined in: src/ai-gateway/client.ts:43

OAuth2 client secret. Falls back to PANW_AI_GW_CLIENT_SECRET, then PANW_MGMT_CLIENT_SECRET.

tsgId?​

optional tsgId?: string;

Defined in: src/ai-gateway/client.ts:45

Tenant Service Group ID. Falls back to PANW_AI_GW_TSG_ID, then PANW_MGMT_TSG_ID.

dataEndpoint?​

optional dataEndpoint?: string;

Defined in: src/ai-gateway/client.ts:47

Data-plane endpoint. Falls back to PANW_AI_GW_DATA_ENDPOINT.

adminEndpoint?​

optional adminEndpoint?: string;

Defined in: src/ai-gateway/client.ts:49

Admin-plane endpoint. Falls back to PANW_AI_GW_ADMIN_ENDPOINT.

iamEndpoint?​

optional iamEndpoint?: string;

Defined in: src/ai-gateway/client.ts:54

SCM IAM endpoint (/iam/v1), used for workspace scopes. Falls back to PANW_IAM_ENDPOINT, then https://api.apps.paloaltonetworks.com/iam/v1.

tokenEndpoint?​

optional tokenEndpoint?: string;

Defined in: src/ai-gateway/client.ts:56

OAuth2 token endpoint. Falls back to PANW_AI_GW_TOKEN_ENDPOINT, then PANW_MGMT_TOKEN_ENDPOINT.

numRetries?​

optional numRetries?: number;

Defined in: src/ai-gateway/client.ts:58

Max retry attempts (0-5). Defaults to 5.