Interface: RedTeamService¶

Defined in: src/airs/types.ts:404

Contract for AI Red Team scan operations.

Methods¶

abortScan()¶

abortScan(jobId): Promise\<void>

Defined in: src/airs/types.ts:500

Abort a running scan.

Parameters¶

jobId¶

string

Returns¶

Promise\<void>

acceptEula()¶

acceptEula(eulaContent): Promise\<EulaStatus>

Defined in: src/airs/types.ts:410

Accept the EULA.

Parameters¶

eulaContent¶

string

Returns¶

Promise\<EulaStatus>

createDevices()¶

createDevices(tenantId, request): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:421

Create devices for an instance.

Parameters¶

tenantId¶

string

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

createInstance()¶

createInstance(request): Promise\<InstanceResponse>

Defined in: src/airs/types.ts:413

Create an instance.

Parameters¶

request¶

InstanceRequest

Returns¶

Promise\<InstanceResponse>

createScan()¶

createScan(request): Promise\<RedTeamJob>

Defined in: src/airs/types.ts:477

Create a red team scan job.

Parameters¶

request¶

attackGoals?¶

string[]

categories?¶

Record\<string, unknown>

customPromptSets?¶

string[]

jobType¶

string

name¶

string

streamBreadth?¶

number

streamDepth?¶

number

targetUuid¶

string

Returns¶

Promise\<RedTeamJob>

createTarget()¶

createTarget(request, opts?): Promise\<RedTeamTargetDetail>

Defined in: src/airs/types.ts:449

Create a red team target.

Parameters¶

deleteDevices()¶

deleteDevices(tenantId, serialNumbers): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:431

Delete devices by serial numbers.

Parameters¶

tenantId¶

string

serialNumbers¶

string

Returns¶

Promise\<Record\<string, unknown>>

deleteInstance()¶

deleteInstance(tenantId): Promise\<InstanceResponse>

Defined in: src/airs/types.ts:419

Delete an instance.

Parameters¶

tenantId¶

string

Returns¶

Promise\<InstanceResponse>

deleteTarget()¶

deleteTarget(uuid): Promise\<void>

Defined in: src/airs/types.ts:462

Delete a red team target.

Parameters¶

uuid¶

string

Returns¶

Promise\<void>

getCategories()¶

getCategories(): Promise\<RedTeamCategory[]>

Defined in: src/airs/types.ts:521

List available attack categories.

Returns¶

Promise\<RedTeamCategory[]>

getCustomReport()¶

getCustomReport(jobId): Promise\<RedTeamCustomReport>

Defined in: src/airs/types.ts:509

Get custom attack report.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamCustomReport>

getDynamicReport()¶

getDynamicReport(jobId): Promise\<RedTeamDynamicReport>

Defined in: src/airs/types.ts:506

Get dynamic scan report.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamDynamicReport>

getEulaContent()¶

getEulaContent(): Promise\<EulaContent>

Defined in: src/airs/types.ts:406

Get EULA content.

Returns¶

Promise\<EulaContent>

getEulaStatus()¶

getEulaStatus(): Promise\<EulaStatus>

Defined in: src/airs/types.ts:408

Get EULA acceptance status.

Returns¶

Promise\<EulaStatus>

getInstance()¶

getInstance(tenantId): Promise\<InstanceDetail>

Defined in: src/airs/types.ts:415

Get instance details.

Parameters¶

tenantId¶

string

Returns¶

Promise\<InstanceDetail>

getRegistryCredentials()¶

getRegistryCredentials(): Promise\<RegistryCredentials>

Defined in: src/airs/types.ts:433

Get or create registry credentials.

Returns¶

Promise\<RegistryCredentials>

getScan()¶

getScan(jobId): Promise\<RedTeamJob>

Defined in: src/airs/types.ts:489

Get scan status by job ID.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamJob>

getStaticReport()¶

getStaticReport(jobId): Promise\<RedTeamStaticReport>

Defined in: src/airs/types.ts:503

Get static scan report.

Parameters¶

jobId¶

string

Returns¶

Promise\<RedTeamStaticReport>

getTarget()¶

getTarget(uuid): Promise\<RedTeamTargetDetail>

Defined in: src/airs/types.ts:446

Get target details.

Parameters¶

uuid¶

string

Returns¶

Promise\<RedTeamTargetDetail>

getTargetMetadata()¶

getTargetMetadata(): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:438

Get target field metadata.

Returns¶

Promise\<Record\<string, unknown>>

getTargetProfile()¶

getTargetProfile(uuid): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:468

Get target profile.

Parameters¶

uuid¶

string

Returns¶

Promise\<Record\<string, unknown>>

getTargetTemplates()¶

getTargetTemplates(): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:440

Get provider-specific target templates.

Returns¶

Promise\<Record\<string, unknown>>

listAttacks()¶

listAttacks(jobId, opts?): Promise\<{ attacks: RedTeamAttack[]; totalItems?: number; }>

Defined in: src/airs/types.ts:512

List attacks from a static/dynamic scan.

Parameters¶

jobId¶

string

opts?¶

limit?¶

number

severity?¶

string

Returns¶

Promise\<{ attacks: RedTeamAttack[]; totalItems?: number; }>

listCustomAttacks()¶

listCustomAttacks(jobId, opts?): Promise\<RedTeamCustomAttack[]>

Defined in: src/airs/types.ts:518

List attacks from a custom prompt set scan.

Parameters¶

jobId¶

string

opts?¶

limit?¶

number

Returns¶

Promise\<RedTeamCustomAttack[]>

listScans()¶

listScans(opts?): Promise\<RedTeamJob[]>

Defined in: src/airs/types.ts:492

List recent scans with optional filters.

Parameters¶

opts?¶

jobType?¶

string

limit?¶

number

status?¶

string

targetId?¶

string

Returns¶

Promise\<RedTeamJob[]>

listTargets()¶

listTargets(): Promise\<RedTeamTarget[]>

Defined in: src/airs/types.ts:443

List configured red team targets.

Returns¶

Promise\<RedTeamTarget[]>

probeTarget()¶

probeTarget(request): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:465

Probe a target connection.

Parameters¶

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

updateDevices()¶

updateDevices(tenantId, request): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:426

Update devices (PATCH).

Parameters¶

tenantId¶

string

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

updateInstance()¶

updateInstance(tenantId, request): Promise\<InstanceResponse>

Defined in: src/airs/types.ts:417

Update an instance.

Parameters¶

tenantId¶

string

request¶

InstanceRequest

Returns¶

Promise\<InstanceResponse>

updateTarget()¶

updateTarget(uuid, request, opts?): Promise\<RedTeamTargetDetail>

Defined in: src/airs/types.ts:455

Update a red team target.

Parameters¶

uuid¶

string

request¶

RedTeamTargetUpdateRequest

opts?¶

TargetOperationOptions

Returns¶

Promise\<RedTeamTargetDetail>

updateTargetProfile()¶

updateTargetProfile(uuid, request): Promise\<Record\<string, unknown>>

Defined in: src/airs/types.ts:471

Update target profile.

Parameters¶

uuid¶

string

request¶

Record\<string, unknown>

Returns¶

Promise\<Record\<string, unknown>>

validateTargetAuth()¶

validateTargetAuth(request): Promise\<TargetAuthValidationResult>

Defined in: src/airs/types.ts:436

Validate target auth credentials.

Parameters¶

request¶

TargetAuthValidationRequest

Returns¶

Promise\<TargetAuthValidationResult>

waitForCompletion()¶

waitForCompletion(jobId, onProgress?, intervalMs?): Promise\<RedTeamJob>

Defined in: src/airs/types.ts:524

Poll until scan completes. Calls onProgress for status updates.

Parameters¶

jobId¶

string

onProgress?¶

(job) => void

intervalMs?¶

number

Returns¶

Promise\<RedTeamJob>