Class: ModelSecurityScansClient

Defined in: src/model-security/scans-client.ts:135

Client for Model Security data plane scan operations.

Constructors

Constructor

new ModelSecurityScansClient(opts): ModelSecurityScansClient;

Defined in: src/model-security/scans-client.ts:140

Parameters

Parameter	Type
`opts`	`ModelSecurityScansClientOptions`

Returns

ModelSecurityScansClient

Methods

create()

create(body): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  created_at: ZodString;
  updated_at: ZodString;
  model_uri: ZodString;
  owner: ZodString;
  scan_origin: ZodString;
  security_group_uuid: ZodString;
  security_group_name: ZodString;
  model_version_uuid: ZodString;
  eval_outcome: ZodString;
  source_type: ZodString;
  created_by: ZodOptional<ZodNullable<ZodString>>;
  enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>;
  error_code: ZodOptional<ZodNullable<ZodString>>;
  error_message: ZodOptional<ZodNullable<ZodString>>;
  eval_summary: ZodOptional<ZodNullable<ZodObject<{
     rules_failed: ZodDefault<ZodOptional<ZodNumber>>;
     rules_passed: ZodDefault<ZodOptional<ZodNumber>>;
     total_rules: ZodDefault<ZodOptional<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rules_failed: ZodDefault<ZodOptional<ZodNumber>>;
     rules_passed: ZodDefault<ZodOptional<ZodNumber>>;
     total_rules: ZodDefault<ZodOptional<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rules_failed: ZodDefault<ZodOptional<ZodNumber>>;
     rules_passed: ZodDefault<ZodOptional<ZodNumber>>;
     total_rules: ZodDefault<ZodOptional<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>>>;
  labels: ZodOptional<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">>;
  model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  scanner_version: ZodOptional<ZodNullable<ZodString>>;
  time_started: ZodOptional<ZodNullable<ZodString>>;
  total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>;
  total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:164

Create a new model security scan.

Parameters

Parameter	Type	Description
`body`	`objectOutputType`	Scan creation request body.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; model_uri: ZodString; owner: ZodString; scan_origin: ZodString; security_group_uuid: ZodString; security_group_name: ZodString; model_version_uuid: ZodString; eval_outcome: ZodString; source_type: ZodString; created_by: ZodOptional<ZodNullable<ZodString>>; enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>; error_code: ZodOptional<ZodNullable<ZodString>>; error_message: ZodOptional<ZodNullable<ZodString>>; eval_summary: ZodOptional<ZodNullable<ZodObject<{ rules_failed: ZodDefault<ZodOptional<ZodNumber>>; rules_passed: ZodDefault<ZodOptional<ZodNumber>>; total_rules: ZodDefault<ZodOptional<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ rules_failed: ZodDefault<ZodOptional<ZodNumber>>; rules_passed: ZodDefault<ZodOptional<ZodNumber>>; total_rules: ZodDefault<ZodOptional<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ rules_failed: ZodDefault<ZodOptional<ZodNumber>>; rules_passed: ZodDefault<ZodOptional<ZodNumber>>; total_rules: ZodDefault<ZodOptional<ZodNumber>>; }, ZodTypeAny, "passthrough">>>>; labels: ZodOptional<ZodArray<ZodObject<{ key: ZodString; value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodString; value: ZodString; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodString; value: ZodString; }, ZodTypeAny, "passthrough">>, "many">>; model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; scanner_version: ZodOptional<ZodNullable<ZodString>>; time_started: ZodOptional<ZodNullable<ZodString>>; total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>; total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>

The created scan response.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const scan = await ms.scans.create({
  model_uri: 'hf://org/model',
  security_group_uuid: '550e8400-e29b-41d4-a716-446655440000',
  scan_origin: 'MODEL_SECURITY_SDK',
});
// scan =>
// { uuid: '550e8400-...', eval_outcome: 'PENDING', source_type: 'HUGGING_FACE', ... }

list()

list(opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  scans: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     model_uri: ZodString;
     owner: ZodString;
     scan_origin: ZodString;
     security_group_uuid: ZodString;
     security_group_name: ZodString;
     model_version_uuid: ZodString;
     eval_outcome: ZodString;
     source_type: ZodString;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>;
     error_code: ZodOptional<ZodNullable<ZodString>>;
     error_message: ZodOptional<ZodNullable<ZodString>>;
     eval_summary: ZodOptional<ZodNullable<ZodObject<{
        rules_failed: ZodDefault<...>;
        rules_passed: ZodDefault<...>;
        total_rules: ZodDefault<...>;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        rules_failed: ...;
        rules_passed: ...;
        total_rules: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        rules_failed: ...;
        rules_passed: ...;
        total_rules: ...;
     }, ZodTypeAny, "passthrough">>>>;
     labels: ZodOptional<ZodArray<ZodObject<{
        key: ZodString;
        value: ZodString;
      }, "passthrough", ZodTypeAny, objectOutputType<{
        key: ...;
        value: ...;
      }, ZodTypeAny, "passthrough">, objectInputType<{
        key: ...;
        value: ...;
     }, ZodTypeAny, "passthrough">>, "many">>;
     model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     scanner_version: ZodOptional<ZodNullable<ZodString>>;
     time_started: ZodOptional<ZodNullable<ZodString>>;
     total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>;
     total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     model_uri: ZodString;
     owner: ZodString;
     scan_origin: ZodString;
     security_group_uuid: ZodString;
     security_group_name: ZodString;
     model_version_uuid: ZodString;
     eval_outcome: ZodString;
     source_type: ZodString;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>;
     error_code: ZodOptional<ZodNullable<ZodString>>;
     error_message: ZodOptional<ZodNullable<ZodString>>;
     eval_summary: ZodOptional<ZodNullable<ZodObject<{
        rules_failed: ...;
        rules_passed: ...;
        total_rules: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     labels: ZodOptional<ZodArray<ZodObject<{
        key: ...;
        value: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
     model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     scanner_version: ZodOptional<ZodNullable<ZodString>>;
     time_started: ZodOptional<ZodNullable<ZodString>>;
     total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>;
     total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     model_uri: ZodString;
     owner: ZodString;
     scan_origin: ZodString;
     security_group_uuid: ZodString;
     security_group_name: ZodString;
     model_version_uuid: ZodString;
     eval_outcome: ZodString;
     source_type: ZodString;
     created_by: ZodOptional<ZodNullable<ZodString>>;
     enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>;
     error_code: ZodOptional<ZodNullable<ZodString>>;
     error_message: ZodOptional<ZodNullable<ZodString>>;
     eval_summary: ZodOptional<ZodNullable<ZodObject<{
        rules_failed: ...;
        rules_passed: ...;
        total_rules: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>;
     labels: ZodOptional<ZodArray<ZodObject<{
        key: ...;
        value: ...;
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>;
     model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     scanner_version: ZodOptional<ZodNullable<ZodString>>;
     time_started: ZodOptional<ZodNullable<ZodString>>;
     total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>;
     total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:190

List model security scans with optional filters.

Parameters

Parameter	Type	Description
`opts?`	`ModelSecurityScanListOptions`	Pagination and filter options.

Returns

Promise<objectOutputType<{ pagination: ZodObject<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ total_items: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>; scans: ZodArray<ZodObject<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; model_uri: ZodString; owner: ZodString; scan_origin: ZodString; security_group_uuid: ZodString; security_group_name: ZodString; model_version_uuid: ZodString; eval_outcome: ZodString; source_type: ZodString; created_by: ZodOptional<ZodNullable<ZodString>>; enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>; error_code: ZodOptional<ZodNullable<ZodString>>; error_message: ZodOptional<ZodNullable<ZodString>>; eval_summary: ZodOptional<ZodNullable<ZodObject<{ rules_failed: ZodDefault<...>; rules_passed: ZodDefault<...>; total_rules: ZodDefault<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ rules_failed: ...; rules_passed: ...; total_rules: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ rules_failed: ...; rules_passed: ...; total_rules: ...; }, ZodTypeAny, "passthrough">>>>; labels: ZodOptional<ZodArray<ZodObject<{ key: ZodString; value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ...; value: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ...; value: ...; }, ZodTypeAny, "passthrough">>, "many">>; model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; scanner_version: ZodOptional<ZodNullable<ZodString>>; time_started: ZodOptional<ZodNullable<ZodString>>; total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>; total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>; }, "passthrough", ZodTypeAny, objectOutputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; model_uri: ZodString; owner: ZodString; scan_origin: ZodString; security_group_uuid: ZodString; security_group_name: ZodString; model_version_uuid: ZodString; eval_outcome: ZodString; source_type: ZodString; created_by: ZodOptional<ZodNullable<ZodString>>; enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>; error_code: ZodOptional<ZodNullable<ZodString>>; error_message: ZodOptional<ZodNullable<ZodString>>; eval_summary: ZodOptional<ZodNullable<ZodObject<{ rules_failed: ...; rules_passed: ...; total_rules: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; labels: ZodOptional<ZodArray<ZodObject<{ key: ...; value: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; scanner_version: ZodOptional<ZodNullable<ZodString>>; time_started: ZodOptional<ZodNullable<ZodString>>; total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>; total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">, objectInputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; model_uri: ZodString; owner: ZodString; scan_origin: ZodString; security_group_uuid: ZodString; security_group_name: ZodString; model_version_uuid: ZodString; eval_outcome: ZodString; source_type: ZodString; created_by: ZodOptional<ZodNullable<ZodString>>; enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>; error_code: ZodOptional<ZodNullable<ZodString>>; error_message: ZodOptional<ZodNullable<ZodString>>; eval_summary: ZodOptional<ZodNullable<ZodObject<{ rules_failed: ...; rules_passed: ...; total_rules: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>>; labels: ZodOptional<ZodArray<ZodObject<{ key: ...; value: ...; }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>, "many">>; model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; scanner_version: ZodOptional<ZodNullable<ZodString>>; time_started: ZodOptional<ZodNullable<ZodString>>; total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>; total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>, "many">; }, ZodTypeAny, "passthrough">>

Paginated list of scans.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const scans = await ms.scans.list({ limit: 5, source_types: ['HUGGING_FACE'] });
// scans =>
// { pagination: { total_items: 42 }, scans: [{ uuid: '550e8400-...', eval_outcome: 'ALLOWED', ... }] }

get()

get(uuid): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  created_at: ZodString;
  updated_at: ZodString;
  model_uri: ZodString;
  owner: ZodString;
  scan_origin: ZodString;
  security_group_uuid: ZodString;
  security_group_name: ZodString;
  model_version_uuid: ZodString;
  eval_outcome: ZodString;
  source_type: ZodString;
  created_by: ZodOptional<ZodNullable<ZodString>>;
  enabled_rule_count_snapshot: ZodOptional<ZodNullable<ZodNumber>>;
  error_code: ZodOptional<ZodNullable<ZodString>>;
  error_message: ZodOptional<ZodNullable<ZodString>>;
  eval_summary: ZodOptional<ZodNullable<ZodObject<{
     rules_failed: ZodDefault<ZodOptional<ZodNumber>>;
     rules_passed: ZodDefault<ZodOptional<ZodNumber>>;
     total_rules: ZodDefault<ZodOptional<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     rules_failed: ZodDefault<ZodOptional<ZodNumber>>;
     rules_passed: ZodDefault<ZodOptional<ZodNumber>>;
     total_rules: ZodDefault<ZodOptional<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     rules_failed: ZodDefault<ZodOptional<ZodNumber>>;
     rules_passed: ZodDefault<ZodOptional<ZodNumber>>;
     total_rules: ZodDefault<ZodOptional<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>>>;
  labels: ZodOptional<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">>;
  model_formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  scanner_version: ZodOptional<ZodNullable<ZodString>>;
  time_started: ZodOptional<ZodNullable<ZodString>>;
  total_files_scanned: ZodOptional<ZodNullable<ZodNumber>>;
  total_files_skipped: ZodOptional<ZodNullable<ZodNumber>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:216

Get a single scan by UUID.

Parameters

Parameter	Type	Description
`uuid`	`string`	Scan UUID.

Returns

The scan response.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const scan = await ms.scans.get('550e8400-e29b-41d4-a716-446655440000');
// scan =>
// { uuid: '550e8400-...', eval_outcome: 'ALLOWED', model_uri: 'hf://org/model', ... }

getEvaluations()

getEvaluations(scanUuid, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  evaluations: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     result: ZodString;
     violation_count: ZodNumber;
     rule_instance_uuid: ZodString;
     scan_uuid: ZodString;
     rule_name: ZodString;
     rule_description: ZodString;
     rule_instance_state: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     result: ZodString;
     violation_count: ZodNumber;
     rule_instance_uuid: ZodString;
     scan_uuid: ZodString;
     rule_name: ZodString;
     rule_description: ZodString;
     rule_instance_state: ZodString;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     result: ZodString;
     violation_count: ZodNumber;
     rule_instance_uuid: ZodString;
     scan_uuid: ZodString;
     rule_name: ZodString;
     rule_description: ZodString;
     rule_instance_state: ZodString;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:245

Get rule evaluations for a scan.

Parameters

Parameter	Type	Description
`scanUuid`	`string`	Scan UUID.
`opts?`	`ModelSecurityEvaluationListOptions`	Pagination and filter options.

Returns

Paginated list of rule evaluations.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const evals = await ms.scans.getEvaluations('550e8400-e29b-41d4-a716-446655440000', {
  result: 'FAILED',
});
// evals.evaluations =>
// [{ uuid: '660e8400-...', rule_name: 'Pickle Scan', result: 'FAILED', violation_count: 2, ... }]

getFiles()

getFiles(scanUuid, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  files: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     path: ZodString;
     parent_path: ZodString;
     type: ZodString;
     result: ZodString;
     model_version_uuid: ZodString;
     blob_id: ZodOptional<ZodNullable<ZodString>>;
     formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     scan_uuid: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     path: ZodString;
     parent_path: ZodString;
     type: ZodString;
     result: ZodString;
     model_version_uuid: ZodString;
     blob_id: ZodOptional<ZodNullable<ZodString>>;
     formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     scan_uuid: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     path: ZodString;
     parent_path: ZodString;
     type: ZodString;
     result: ZodString;
     model_version_uuid: ZodString;
     blob_id: ZodOptional<ZodNullable<ZodString>>;
     formats: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     scan_uuid: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:278

Get files for a scan.

Parameters

Parameter	Type	Description
`scanUuid`	`string`	Scan UUID.
`opts?`	`ModelSecurityFileListOptions`	Pagination and file filter options.

Returns

Paginated list of files.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const files = await ms.scans.getFiles('550e8400-e29b-41d4-a716-446655440000', {
  query_path: '/',
});
// files.files =>
// [{ uuid: '660e8400-...', path: '/model.bin', type: 'FILE', result: 'SUCCESS', ... }]

addLabels()

addLabels(scanUuid, body): Promise<objectOutputType<{
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:307

Add labels to a scan (merge with existing).

Parameters

Parameter	Type	Description
`scanUuid`	`string`	Scan UUID.
`body`	`objectOutputType`	Labels to add.

Returns

Promise<objectOutputType<{ }, ZodTypeAny, "passthrough">>

Labels response.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const res = await ms.scans.addLabels('550e8400-e29b-41d4-a716-446655440000', {
  labels: [{ key: 'env', value: 'prod' }],
});
// res => {} (empty object on success)

setLabels()

setLabels(scanUuid, body): Promise<objectOutputType<{
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:336

Set labels on a scan (replace all existing).

Parameters

Parameter	Type	Description
`scanUuid`	`string`	Scan UUID.
`body`	`objectOutputType`	Labels to set.

Returns

Promise<objectOutputType<{ }, ZodTypeAny, "passthrough">>

Labels response.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const res = await ms.scans.setLabels('550e8400-e29b-41d4-a716-446655440000', {
  labels: [{ key: 'env', value: 'staging' }],
});
// res => {} (empty object on success)

deleteLabels()

deleteLabels(scanUuid, keys): Promise<void>;

Defined in: src/model-security/scans-client.ts:363

Delete labels from a scan by key.

Parameters

Parameter	Type	Description
`scanUuid`	`string`	Scan UUID.
`keys`	`string`[]	Label keys to delete.

Returns

Promise<void>

Resolves when the labels are deleted.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

await ms.scans.deleteLabels('550e8400-e29b-41d4-a716-446655440000', ['env', 'team']);
// resolves to undefined on success

getViolations()

getViolations(scanUuid, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  violations: ZodArray<ZodObject<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     description: ZodString;
     rule_instance_uuid: ZodString;
     rule_name: ZodString;
     rule_description: ZodString;
     rule_instance_state: ZodString;
     file: ZodOptional<ZodNullable<ZodString>>;
     hash: ZodOptional<ZodNullable<ZodString>>;
     module: ZodOptional<ZodNullable<ZodString>>;
     operator: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodNullable<ZodString>>;
     threat_description: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     description: ZodString;
     rule_instance_uuid: ZodString;
     rule_name: ZodString;
     rule_description: ZodString;
     rule_instance_state: ZodString;
     file: ZodOptional<ZodNullable<ZodString>>;
     hash: ZodOptional<ZodNullable<ZodString>>;
     module: ZodOptional<ZodNullable<ZodString>>;
     operator: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodNullable<ZodString>>;
     threat_description: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     uuid: ZodString;
     tsg_id: ZodString;
     created_at: ZodString;
     updated_at: ZodString;
     description: ZodString;
     rule_instance_uuid: ZodString;
     rule_name: ZodString;
     rule_description: ZodString;
     rule_instance_state: ZodString;
     file: ZodOptional<ZodNullable<ZodString>>;
     hash: ZodOptional<ZodNullable<ZodString>>;
     module: ZodOptional<ZodNullable<ZodString>>;
     operator: ZodOptional<ZodNullable<ZodString>>;
     threat: ZodOptional<ZodNullable<ZodString>>;
     threat_description: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:390

Get rule violations for a scan.

Parameters

Parameter	Type	Description
`scanUuid`	`string`	Scan UUID.
`opts?`	`ListingOptions`	Pagination options.

Returns

Paginated list of violations.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const v = await ms.scans.getViolations('550e8400-e29b-41d4-a716-446655440000', { limit: 10 });
// v.violations =>
// [{ uuid: '660e8400-...', rule_name: 'Pickle Scan', description: 'Unsafe pickle opcode', ... }]

getLabelKeys()

getLabelKeys(opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  keys: ZodArray<ZodString, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:420

Get distinct label keys across all scans.

Parameters

Parameter	Type	Description
`opts?`	`ListingOptions`	Pagination options.

Returns

Paginated list of label keys.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const keys = await ms.scans.getLabelKeys({ limit: 50 });
// keys =>
// { pagination: { total_items: 3 }, keys: ['env', 'team', 'owner'] }

getLabelValues()

getLabelValues(key, opts?): Promise<objectOutputType<{
  pagination: ZodObject<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     total_items: ZodOptional<ZodNullable<ZodNumber>>;
  }, ZodTypeAny, "passthrough">>;
  values: ZodArray<ZodString, "many">;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:447

Get distinct values for a label key.

Parameters

Parameter	Type	Description
`key`	`string`	Label key to get values for.
`opts?`	`ListingOptions`	Pagination options.

Returns

Paginated list of label values.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const values = await ms.scans.getLabelValues('env', { limit: 50 });
// values =>
// { pagination: { total_items: 2 }, values: ['prod', 'staging'] }

getEvaluation()

getEvaluation(uuid): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  created_at: ZodString;
  updated_at: ZodString;
  result: ZodString;
  violation_count: ZodNumber;
  rule_instance_uuid: ZodString;
  scan_uuid: ZodString;
  rule_name: ZodString;
  rule_description: ZodString;
  rule_instance_state: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:473

Get a single rule evaluation by UUID.

Parameters

Parameter	Type	Description
`uuid`	`string`	Evaluation UUID.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; result: ZodString; violation_count: ZodNumber; rule_instance_uuid: ZodString; scan_uuid: ZodString; rule_name: ZodString; rule_description: ZodString; rule_instance_state: ZodString; }, ZodTypeAny, "passthrough">>

The rule evaluation response.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const ev = await ms.scans.getEvaluation('660e8400-e29b-41d4-a716-446655440000');
// ev =>
// { uuid: '660e8400-...', rule_name: 'Pickle Scan', result: 'FAILED', violation_count: 2, ... }

getViolation()

getViolation(uuid): Promise<objectOutputType<{
  uuid: ZodString;
  tsg_id: ZodString;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodString;
  rule_instance_uuid: ZodString;
  rule_name: ZodString;
  rule_description: ZodString;
  rule_instance_state: ZodString;
  file: ZodOptional<ZodNullable<ZodString>>;
  hash: ZodOptional<ZodNullable<ZodString>>;
  module: ZodOptional<ZodNullable<ZodString>>;
  operator: ZodOptional<ZodNullable<ZodString>>;
  threat: ZodOptional<ZodNullable<ZodString>>;
  threat_description: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/model-security/scans-client.ts:499

Get a single violation by UUID.

Parameters

Parameter	Type	Description
`uuid`	`string`	Violation UUID.

Returns

Promise<objectOutputType<{ uuid: ZodString; tsg_id: ZodString; created_at: ZodString; updated_at: ZodString; description: ZodString; rule_instance_uuid: ZodString; rule_name: ZodString; rule_description: ZodString; rule_instance_state: ZodString; file: ZodOptional<ZodNullable<ZodString>>; hash: ZodOptional<ZodNullable<ZodString>>; module: ZodOptional<ZodNullable<ZodString>>; operator: ZodOptional<ZodNullable<ZodString>>; threat: ZodOptional<ZodNullable<ZodString>>; threat_description: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The violation response.

Example

import { ModelSecurityClient } from '@cdot65/prisma-airs-sdk';
const ms = new ModelSecurityClient();

const violation = await ms.scans.getViolation('660e8400-e29b-41d4-a716-446655440000');
// violation =>
// { uuid: '660e8400-...', rule_name: 'Pickle Scan', description: 'Unsafe pickle opcode', ... }

Constructors​

Constructor​

Parameters​

Returns​

Methods​

create()​

Parameters​

Returns​

Example​

list()​

Parameters​

Returns​

Example​

get()​

Parameters​

Returns​

Example​

getEvaluations()​

Parameters​

Returns​

Example​

getFiles()​

Parameters​

Returns​

Example​

addLabels()​

Parameters​

Returns​

Example​

setLabels()​

Parameters​

Returns​

Example​

deleteLabels()​

Parameters​

Returns​

Example​

getViolations()​

Parameters​

Returns​

Example​

getLabelKeys()​

Parameters​

Returns​

Example​

getLabelValues()​

Parameters​

Returns​

Example​

getEvaluation()​

Parameters​

Returns​

Example​

getViolation()​

Parameters​

Returns​

Example​

Constructors

Constructor

Parameters

Returns

Methods

create()

Parameters

Returns

Example

list()

Parameters

Returns

Example

get()

Parameters

Returns

Example

getEvaluations()

Parameters

Returns

Example

getFiles()

Parameters

Returns

Example

addLabels()

Parameters

Returns

Example

setLabels()

Parameters

Returns

Example

deleteLabels()

Parameters

Returns

Example

getViolations()

Parameters

Returns

Example

getLabelKeys()

Parameters

Returns

Example

getLabelValues()

Parameters

Returns

Example

getEvaluation()

Parameters

Returns

Example

getViolation()

Parameters

Returns

Example