Skip to main content

Class: AgentGuardClient

Defined in: src/agentguard/client.ts:55

Experimental read-only AI Supply Chain AgentGuard APIs, derived from browser captures.

Example​

const client = new AgentGuardClient(); // PANW_AGENT_GUARD_* falling back to PANW_MGMT_*
const page = await client.listScans({ limit: 10, skip: 0 });
// page.scans contains skill and agent scans; page.pagination.total_items is the total.

Constructors​

Constructor​

new AgentGuardClient(opts?): AgentGuardClient;

Defined in: src/agentguard/client.ts:61

Parameters​

ParameterType
optsAgentGuardClientOptions

Returns​

AgentGuardClient

Methods​

listScans()​

listScans(options?): Promise<objectInputType<{
  pagination: ZodObject<{
     total_items: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodNumber;
  }, ZodTypeAny, "passthrough">>;
  scans: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     name: ZodString;
     git_url: ZodNullable<ZodString>;
     artifact_type: ZodString;
     status: ZodString;
     error_message: ZodNullable<ZodString>;
     summary: ZodNullable<ZodObject<{
        vulnerability_count: ZodNumber;
        attack_chain_count: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        vulnerability_count: ZodNumber;
        attack_chain_count: ZodNumber;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        vulnerability_count: ZodNumber;
        attack_chain_count: ZodNumber;
     }, ZodTypeAny, "passthrough">>>;
     eval_outcome: ZodNullable<ZodString>;
     eval_summary: ZodNullable<ZodObject<{
        total_rules: ZodNumber;
        blocked: ZodNumber;
        allowed: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        total_rules: ZodNumber;
        blocked: ZodNumber;
        allowed: ZodNumber;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        total_rules: ZodNumber;
        blocked: ZodNumber;
        allowed: ZodNumber;
     }, ZodTypeAny, "passthrough">>>;
     eval_details: ZodNullable<ZodObject<{
        rule_outcomes: ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">;
        skill_override_applied: ZodBoolean;
        unknown_findings: ZodArray<ZodUnknown, "many">;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        rule_outcomes: ZodArray<..., ...>;
        skill_override_applied: ZodBoolean;
        unknown_findings: ZodArray<..., ...>;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        rule_outcomes: ZodArray<..., ...>;
        skill_override_applied: ZodBoolean;
        unknown_findings: ZodArray<..., ...>;
     }, ZodTypeAny, "passthrough">>>;
     duration_seconds: ZodNullable<ZodNumber>;
     fingerprint: ZodString;
     scanner_version: ZodNullable<ZodString>;
     device_metadata: ZodNullable<ZodRecord<ZodString, ZodUnknown>>;
     parent_uuid: ZodNullable<ZodString>;
     is_batch: ZodBoolean;
     child_scan_uuids: ZodArray<ZodString, "many">;
     batch_summary: ZodUnknown;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     name: ZodString;
     git_url: ZodNullable<ZodString>;
     artifact_type: ZodString;
     status: ZodString;
     error_message: ZodNullable<ZodString>;
     summary: ZodNullable<ZodObject<{
        vulnerability_count: ZodNumber;
        attack_chain_count: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        vulnerability_count: ...;
        attack_chain_count: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        vulnerability_count: ...;
        attack_chain_count: ...;
     }, ZodTypeAny, "passthrough">>>;
     eval_outcome: ZodNullable<ZodString>;
     eval_summary: ZodNullable<ZodObject<{
        total_rules: ZodNumber;
        blocked: ZodNumber;
        allowed: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        total_rules: ...;
        blocked: ...;
        allowed: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        total_rules: ...;
        blocked: ...;
        allowed: ...;
     }, ZodTypeAny, "passthrough">>>;
     eval_details: ZodNullable<ZodObject<{
        rule_outcomes: ZodArray<..., ...>;
        skill_override_applied: ZodBoolean;
        unknown_findings: ZodArray<..., ...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        rule_outcomes: ...;
        skill_override_applied: ...;
        unknown_findings: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        rule_outcomes: ...;
        skill_override_applied: ...;
        unknown_findings: ...;
     }, ZodTypeAny, "passthrough">>>;
     duration_seconds: ZodNullable<ZodNumber>;
     fingerprint: ZodString;
     scanner_version: ZodNullable<ZodString>;
     device_metadata: ZodNullable<ZodRecord<ZodString, ZodUnknown>>;
     parent_uuid: ZodNullable<ZodString>;
     is_batch: ZodBoolean;
     child_scan_uuids: ZodArray<ZodString, "many">;
     batch_summary: ZodUnknown;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     name: ZodString;
     git_url: ZodNullable<ZodString>;
     artifact_type: ZodString;
     status: ZodString;
     error_message: ZodNullable<ZodString>;
     summary: ZodNullable<ZodObject<{
        vulnerability_count: ZodNumber;
        attack_chain_count: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        vulnerability_count: ...;
        attack_chain_count: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        vulnerability_count: ...;
        attack_chain_count: ...;
     }, ZodTypeAny, "passthrough">>>;
     eval_outcome: ZodNullable<ZodString>;
     eval_summary: ZodNullable<ZodObject<{
        total_rules: ZodNumber;
        blocked: ZodNumber;
        allowed: ZodNumber;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        total_rules: ...;
        blocked: ...;
        allowed: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        total_rules: ...;
        blocked: ...;
        allowed: ...;
     }, ZodTypeAny, "passthrough">>>;
     eval_details: ZodNullable<ZodObject<{
        rule_outcomes: ZodArray<..., ...>;
        skill_override_applied: ZodBoolean;
        unknown_findings: ZodArray<..., ...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        rule_outcomes: ...;
        skill_override_applied: ...;
        unknown_findings: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        rule_outcomes: ...;
        skill_override_applied: ...;
        unknown_findings: ...;
     }, ZodTypeAny, "passthrough">>>;
     duration_seconds: ZodNullable<ZodNumber>;
     fingerprint: ZodString;
     scanner_version: ZodNullable<ZodString>;
     device_metadata: ZodNullable<ZodRecord<ZodString, ZodUnknown>>;
     parent_uuid: ZodNullable<ZodString>;
     is_batch: ZodBoolean;
     child_scan_uuids: ZodArray<ZodString, "many">;
     batch_summary: ZodUnknown;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/agentguard/client.ts:102

List one page of agent and skill scans. Invalid queries fail before authentication.

Parameters​

ParameterType
options{ skip?: number; limit?: number; isBackgroundRefresh?: boolean; start_time?: string; end_time?: string; }
options.skip?number
options.limit?number
options.isBackgroundRefresh?boolean
options.start_time?string
options.end_time?string

Returns​

Promise<objectInputType<{ pagination: ZodObject<{ total_items: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodNumber; }, ZodTypeAny, "passthrough">>; scans: ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; name: ZodString; git_url: ZodNullable<ZodString>; artifact_type: ZodString; status: ZodString; error_message: ZodNullable<ZodString>; summary: ZodNullable<ZodObject<{ vulnerability_count: ZodNumber; attack_chain_count: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ vulnerability_count: ZodNumber; attack_chain_count: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ vulnerability_count: ZodNumber; attack_chain_count: ZodNumber; }, ZodTypeAny, "passthrough">>>; eval_outcome: ZodNullable<ZodString>; eval_summary: ZodNullable<ZodObject<{ total_rules: ZodNumber; blocked: ZodNumber; allowed: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ total_rules: ZodNumber; blocked: ZodNumber; allowed: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ total_rules: ZodNumber; blocked: ZodNumber; allowed: ZodNumber; }, ZodTypeAny, "passthrough">>>; eval_details: ZodNullable<ZodObject<{ rule_outcomes: ZodArray<ZodObject<..., ..., ..., ..., ...>, "many">; skill_override_applied: ZodBoolean; unknown_findings: ZodArray<ZodUnknown, "many">; }, "passthrough", ZodTypeAny, objectOutputType<{ rule_outcomes: ZodArray<..., ...>; skill_override_applied: ZodBoolean; unknown_findings: ZodArray<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ rule_outcomes: ZodArray<..., ...>; skill_override_applied: ZodBoolean; unknown_findings: ZodArray<..., ...>; }, ZodTypeAny, "passthrough">>>; duration_seconds: ZodNullable<ZodNumber>; fingerprint: ZodString; scanner_version: ZodNullable<ZodString>; device_metadata: ZodNullable<ZodRecord<ZodString, ZodUnknown>>; parent_uuid: ZodNullable<ZodString>; is_batch: ZodBoolean; child_scan_uuids: ZodArray<ZodString, "many">; batch_summary: ZodUnknown; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; name: ZodString; git_url: ZodNullable<ZodString>; artifact_type: ZodString; status: ZodString; error_message: ZodNullable<ZodString>; summary: ZodNullable<ZodObject<{ vulnerability_count: ZodNumber; attack_chain_count: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ vulnerability_count: ...; attack_chain_count: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ vulnerability_count: ...; attack_chain_count: ...; }, ZodTypeAny, "passthrough">>>; eval_outcome: ZodNullable<ZodString>; eval_summary: ZodNullable<ZodObject<{ total_rules: ZodNumber; blocked: ZodNumber; allowed: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ total_rules: ...; blocked: ...; allowed: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ total_rules: ...; blocked: ...; allowed: ...; }, ZodTypeAny, "passthrough">>>; eval_details: ZodNullable<ZodObject<{ rule_outcomes: ZodArray<..., ...>; skill_override_applied: ZodBoolean; unknown_findings: ZodArray<..., ...>; }, "passthrough", ZodTypeAny, objectOutputType<{ rule_outcomes: ...; skill_override_applied: ...; unknown_findings: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ rule_outcomes: ...; skill_override_applied: ...; unknown_findings: ...; }, ZodTypeAny, "passthrough">>>; duration_seconds: ZodNullable<ZodNumber>; fingerprint: ZodString; scanner_version: ZodNullable<ZodString>; device_metadata: ZodNullable<ZodRecord<ZodString, ZodUnknown>>; parent_uuid: ZodNullable<ZodString>; is_batch: ZodBoolean; child_scan_uuids: ZodArray<ZodString, "many">; batch_summary: ZodUnknown; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; name: ZodString; git_url: ZodNullable<ZodString>; artifact_type: ZodString; status: ZodString; error_message: ZodNullable<ZodString>; summary: ZodNullable<ZodObject<{ vulnerability_count: ZodNumber; attack_chain_count: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ vulnerability_count: ...; attack_chain_count: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ vulnerability_count: ...; attack_chain_count: ...; }, ZodTypeAny, "passthrough">>>; eval_outcome: ZodNullable<ZodString>; eval_summary: ZodNullable<ZodObject<{ total_rules: ZodNumber; blocked: ZodNumber; allowed: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ total_rules: ...; blocked: ...; allowed: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ total_rules: ...; blocked: ...; allowed: ...; }, ZodTypeAny, "passthrough">>>; eval_details: ZodNullable<ZodObject<{ rule_outcomes: ZodArray<..., ...>; skill_override_applied: ZodBoolean; unknown_findings: ZodArray<..., ...>; }, "passthrough", ZodTypeAny, objectOutputType<{ rule_outcomes: ...; skill_override_applied: ...; unknown_findings: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ rule_outcomes: ...; skill_override_applied: ...; unknown_findings: ...; }, ZodTypeAny, "passthrough">>>; duration_seconds: ZodNullable<ZodNumber>; fingerprint: ZodString; scanner_version: ZodNullable<ZodString>; device_metadata: ZodNullable<ZodRecord<ZodString, ZodUnknown>>; parent_uuid: ZodNullable<ZodString>; is_batch: ZodBoolean; child_scan_uuids: ZodArray<ZodString, "many">; batch_summary: ZodUnknown; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example​

`const page = await client.listScans({ skip: 0, limit: 10, isBackgroundRefresh: false });`

getScanStats()​

getScanStats(options?): Promise<objectInputType<{
  unique_skills_scanned: ZodObject<{
     count: ZodNumber;
     percent_change: ZodNullable<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     count: ZodNumber;
     percent_change: ZodNullable<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     count: ZodNumber;
     percent_change: ZodNullable<ZodNumber>;
  }, ZodTypeAny, "passthrough">>;
  total_vulnerabilities_found: ZodObject<{
     count: ZodNumber;
     percent_change: ZodNullable<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     count: ZodNumber;
     percent_change: ZodNullable<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     count: ZodNumber;
     percent_change: ZodNullable<ZodNumber>;
  }, ZodTypeAny, "passthrough">>;
  top_vulnerability: ZodNullable<ZodObject<{
     vulnerability_type: ZodString;
     finding_count: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     vulnerability_type: ZodString;
     finding_count: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     vulnerability_type: ZodString;
     finding_count: ZodNumber;
  }, ZodTypeAny, "passthrough">>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/agentguard/client.ts:114

Retrieve server-reported 30-day skill statistics.

Parameters​

ParameterType
options{ time_period?: "30_DAYS"; }
options.time_period?"30_DAYS"

Returns​

Promise<objectInputType<{ unique_skills_scanned: ZodObject<{ count: ZodNumber; percent_change: ZodNullable<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ count: ZodNumber; percent_change: ZodNullable<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ count: ZodNumber; percent_change: ZodNullable<ZodNumber>; }, ZodTypeAny, "passthrough">>; total_vulnerabilities_found: ZodObject<{ count: ZodNumber; percent_change: ZodNullable<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ count: ZodNumber; percent_change: ZodNullable<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ count: ZodNumber; percent_change: ZodNullable<ZodNumber>; }, ZodTypeAny, "passthrough">>; top_vulnerability: ZodNullable<ZodObject<{ vulnerability_type: ZodString; finding_count: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ vulnerability_type: ZodString; finding_count: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ vulnerability_type: ZodString; finding_count: ZodNumber; }, ZodTypeAny, "passthrough">>>; }, ZodTypeAny, "passthrough">>

Example​

`const stats = await client.getScanStats({ time_period: '30_DAYS' });`

listScanVulnerabilities()​

listScanVulnerabilities(scanUuid): Promise<objectInputType<{
  pagination: ZodObject<{
     total_items: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodNumber;
  }, ZodTypeAny, "passthrough">>;
  vulnerabilities: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     scan_uuid: ZodString;
     title: ZodString;
     description: ZodString;
     vulnerability_type: ZodString;
     file_path: ZodString;
     node_id: ZodNullable<ZodString>;
     node_type: ZodNullable<ZodString>;
     node_name: ZodNullable<ZodString>;
     remediation_description: ZodNullable<ZodString>;
     original_code: ZodNullable<ZodString>;
     suggested_code: ZodNullable<ZodString>;
     attack_chain_count: ZodNumber;
     attack_chain_uuids: ZodArray<ZodString, "many">;
     type_description: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     scan_uuid: ZodString;
     title: ZodString;
     description: ZodString;
     vulnerability_type: ZodString;
     file_path: ZodString;
     node_id: ZodNullable<ZodString>;
     node_type: ZodNullable<ZodString>;
     node_name: ZodNullable<ZodString>;
     remediation_description: ZodNullable<ZodString>;
     original_code: ZodNullable<ZodString>;
     suggested_code: ZodNullable<ZodString>;
     attack_chain_count: ZodNumber;
     attack_chain_uuids: ZodArray<ZodString, "many">;
     type_description: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     scan_uuid: ZodString;
     title: ZodString;
     description: ZodString;
     vulnerability_type: ZodString;
     file_path: ZodString;
     node_id: ZodNullable<ZodString>;
     node_type: ZodNullable<ZodString>;
     node_name: ZodNullable<ZodString>;
     remediation_description: ZodNullable<ZodString>;
     original_code: ZodNullable<ZodString>;
     suggested_code: ZodNullable<ZodString>;
     attack_chain_count: ZodNumber;
     attack_chain_uuids: ZodArray<ZodString, "many">;
     type_description: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/agentguard/client.ts:124

Get findings for a scan. Content may contain secrets; never include it in a public report.

Parameters​

ParameterType
scanUuidstring

Returns​

Promise<objectInputType<{ pagination: ZodObject<{ total_items: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodNumber; }, ZodTypeAny, "passthrough">>; vulnerabilities: ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; scan_uuid: ZodString; title: ZodString; description: ZodString; vulnerability_type: ZodString; file_path: ZodString; node_id: ZodNullable<ZodString>; node_type: ZodNullable<ZodString>; node_name: ZodNullable<ZodString>; remediation_description: ZodNullable<ZodString>; original_code: ZodNullable<ZodString>; suggested_code: ZodNullable<ZodString>; attack_chain_count: ZodNumber; attack_chain_uuids: ZodArray<ZodString, "many">; type_description: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; scan_uuid: ZodString; title: ZodString; description: ZodString; vulnerability_type: ZodString; file_path: ZodString; node_id: ZodNullable<ZodString>; node_type: ZodNullable<ZodString>; node_name: ZodNullable<ZodString>; remediation_description: ZodNullable<ZodString>; original_code: ZodNullable<ZodString>; suggested_code: ZodNullable<ZodString>; attack_chain_count: ZodNumber; attack_chain_uuids: ZodArray<ZodString, "many">; type_description: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; scan_uuid: ZodString; title: ZodString; description: ZodString; vulnerability_type: ZodString; file_path: ZodString; node_id: ZodNullable<ZodString>; node_type: ZodNullable<ZodString>; node_name: ZodNullable<ZodString>; remediation_description: ZodNullable<ZodString>; original_code: ZodNullable<ZodString>; suggested_code: ZodNullable<ZodString>; attack_chain_count: ZodNumber; attack_chain_uuids: ZodArray<ZodString, "many">; type_description: ZodString; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example​

`const findings = await client.listScanVulnerabilities('c3f3192d-7ff1-4b03-81e0-d392a0dd7a3f');`

listRules()​

listRules(options?): Promise<objectInputType<{
  pagination: ZodObject<{
     total_items: ZodNumber;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodNumber;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodNumber;
  }, ZodTypeAny, "passthrough">>;
  rules: ZodArray<ZodObject<{
     uuid: ZodString;
     name: ZodString;
     vulnerability_types: ZodArray<ZodString, "many">;
     default_state: ZodString;
     description: ZodString;
     remediation: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     name: ZodString;
     vulnerability_types: ZodArray<ZodString, "many">;
     default_state: ZodString;
     description: ZodString;
     remediation: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     name: ZodString;
     vulnerability_types: ZodArray<ZodString, "many">;
     default_state: ZodString;
     description: ZodString;
     remediation: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/agentguard/client.ts:138

List rule catalog defaults, not effective tenant policy settings. The observed API's pagination.total_items is the current page count, not the catalog total. Continue with increasing skip until a short/empty page; apply a budget and duplicate guard.

Parameters​

ParameterType
options{ skip?: number; limit?: number; }
options.skip?number
options.limit?number

Returns​

Promise<objectInputType<{ pagination: ZodObject<{ total_items: ZodNumber; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodNumber; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodNumber; }, ZodTypeAny, "passthrough">>; rules: ZodArray<ZodObject<{ uuid: ZodString; name: ZodString; vulnerability_types: ZodArray<ZodString, "many">; default_state: ZodString; description: ZodString; remediation: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; name: ZodString; vulnerability_types: ZodArray<ZodString, "many">; default_state: ZodString; description: ZodString; remediation: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; name: ZodString; vulnerability_types: ZodArray<ZodString, "many">; default_state: ZodString; description: ZodString; remediation: ZodString; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Example​

`const catalog = await client.listRules({ skip: 0, limit: 100 });`