Class: AIGatewayPluginsClient
Defined in: src/ai-gateway/plugins-client.ts:24
Client for AI Gateway plugin bindings (admin plane).
Constructors
Constructor
new AIGatewayPluginsClient(opts): AIGatewayPluginsClient;
Defined in: src/ai-gateway/plugins-client.ts:29
Parameters
| Parameter | Type |
|---|---|
opts | AIGatewaySubClientOptions |
Returns
AIGatewayPluginsClient
Methods
list()
list(): Promise<objectOutputType<{
object: ZodString;
total: ZodNumber;
has_more: ZodOptional<ZodBoolean>;
data: ZodArray<ZodObject<{
id: ZodString;
integration_id: ZodString;
credentials: ZodRecord<ZodString, ZodString>;
owner_id: ZodString;
created_at: ZodString;
last_updated_at: ZodString;
status: ZodString;
integration_slug: ZodString;
plugin_provider_id: ZodString;
plugin_provider_slug: ZodString;
object: ZodString;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodString;
integration_id: ZodString;
credentials: ZodRecord<ZodString, ZodString>;
owner_id: ZodString;
created_at: ZodString;
last_updated_at: ZodString;
status: ZodString;
integration_slug: ZodString;
plugin_provider_id: ZodString;
plugin_provider_slug: ZodString;
object: ZodString;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodString;
integration_id: ZodString;
credentials: ZodRecord<ZodString, ZodString>;
owner_id: ZodString;
created_at: ZodString;
last_updated_at: ZodString;
status: ZodString;
integration_slug: ZodString;
plugin_provider_id: ZodString;
plugin_provider_slug: ZodString;
object: ZodString;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;
Defined in: src/ai-gateway/plugins-client.ts:47
List organisation plugin bindings.
Returns
Promise<objectOutputType<{
object: ZodString;
total: ZodNumber;
has_more: ZodOptional<ZodBoolean>;
data: ZodArray<ZodObject<{
id: ZodString;
integration_id: ZodString;
credentials: ZodRecord<ZodString, ZodString>;
owner_id: ZodString;
created_at: ZodString;
last_updated_at: ZodString;
status: ZodString;
integration_slug: ZodString;
plugin_provider_id: ZodString;
plugin_provider_slug: ZodString;
object: ZodString;
}, "passthrough", ZodTypeAny, objectOutputType<{
id: ZodString;
integration_id: ZodString;
credentials: ZodRecord<ZodString, ZodString>;
owner_id: ZodString;
created_at: ZodString;
last_updated_at: ZodString;
status: ZodString;
integration_slug: ZodString;
plugin_provider_id: ZodString;
plugin_provider_slug: ZodString;
object: ZodString;
}, ZodTypeAny, "passthrough">, objectInputType<{
id: ZodString;
integration_id: ZodString;
credentials: ZodRecord<ZodString, ZodString>;
owner_id: ZodString;
created_at: ZodString;
last_updated_at: ZodString;
status: ZodString;
integration_slug: ZodString;
plugin_provider_id: ZodString;
plugin_provider_slug: ZodString;
object: ZodString;
}, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>
All plugins bound to the organisation, with masked credentials.
Example
import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();
const p = await gw.plugins.list();
// p.data[0] => { integration_slug: 'panw-prisma-airs', credentials: { AIRS_API_KEY: 'sn*****Gul' }, ... }
create()
create(body): Promise<objectOutputType<{
}, ZodTypeAny, "passthrough">>;
Defined in: src/ai-gateway/plugins-client.ts:79
Bind a plugin to the organisation.
Parameters
| Parameter | Type | Description |
|---|---|---|
body | GatewayPluginCreateRequest | Integration id and provider-specific credentials. |
Returns
Promise<objectOutputType<{
}, ZodTypeAny, "passthrough">>
The raw create response. Shape unverified against a live tenant — see the PRD.
Remarks
body.credentials (e.g. AIRS_API_KEY) is a live secret. Setting PANW_AI_SEC_DEBUG
will print it, unredacted, to the SDK's own debug log.
Example
import { AIGatewayClient } from '@cdot65/prisma-airs-sdk';
const gw = new AIGatewayClient();
await gw.plugins.create({
organisation_id: '1852583913',
integration_id: '232e45c4-809a-11f1-af60-2ca2a760eb7b',
credentials: { AIRS_API_KEY: process.env.PANW_AI_SEC_API_KEY ?? '' },
});