Class: SdkRedTeamService

Defined in: src/airs/redteam.ts:234

Contract for AI Red Team scan operations.

Implements

• RedTeamService

Constructors

Constructor

new SdkRedTeamService(opts?): SdkRedTeamService

Defined in: src/airs/redteam.ts:237

Parameters

opts?

RedTeamClientOptions

Returns

SdkRedTeamService

Methods

abortScan()

abortScan(jobId): Promise<void>

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

Abort a running scan.

Parameters

jobId

string

Returns

Promise<void>

Implementation of

RedTeamService.abortScan

---

acceptEula()

acceptEula(eulaContent): Promise<EulaStatus>

Defined in: src/airs/redteam.ts:255

Accept the EULA.

Parameters

eulaContent

string

Returns

Promise<EulaStatus>

Implementation of

RedTeamService.acceptEula

---

createAdapter()

createAdapter(request, validate?): Promise<RedTeamAdapterDetail>

Defined in: src/airs/redteam.ts:784

Parameters

request

RedTeamAdapterCreateRequest

validate?

boolean

Returns

Promise<RedTeamAdapterDetail>

Implementation of

RedTeamService.createAdapter

---

createChannel()

createChannel(request): Promise<RedTeamChannel>

Defined in: src/airs/redteam.ts:689

Create a network broker channel.

Parameters

request

RedTeamChannelCreateRequest

Returns

Promise<RedTeamChannel>

Implementation of

RedTeamService.createChannel

---

createDevices()

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

Defined in: src/airs/redteam.ts:317

Create devices for an instance.

Parameters

tenantId

string

request

Record<string, unknown>

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.createDevices

---

createInstance()

createInstance(request): Promise<InstanceResponse>

Defined in: src/airs/redteam.ts:267

Create an instance.

Parameters

request

InstanceRequest

Returns

Promise<InstanceResponse>

Implementation of

RedTeamService.createInstance

---

createScan()

createScan(request): Promise<RedTeamJob>

Defined in: src/airs/redteam.ts:456

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>

Implementation of

RedTeamService.createScan

---

createTarget()

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

Defined in: src/airs/redteam.ts:412

Create a red team target.

Parameters

request

RedTeamTargetCreateRequest

opts?

TargetOperationOptions

Returns

Promise<RedTeamTargetDetail>

Implementation of

RedTeamService.createTarget

---

deleteAdapter()

deleteAdapter(uuid): Promise<void>

Defined in: src/airs/redteam.ts:838

Parameters

uuid

string

Returns

Promise<void>

Implementation of

RedTeamService.deleteAdapter

---

deleteDevices()

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

Defined in: src/airs/redteam.ts:337

Delete devices by serial numbers.

Parameters

tenantId

string

serialNumbers

string

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.deleteDevices

---

deleteInstance()

deleteInstance(tenantId): Promise<InstanceResponse>

Defined in: src/airs/redteam.ts:307

Delete an instance.

Parameters

tenantId

string

Returns

Promise<InstanceResponse>

Implementation of

RedTeamService.deleteInstance

---

deleteTarget()

deleteTarget(uuid): Promise<void>

Defined in: src/airs/redteam.ts:429

Delete a red team target.

Parameters

uuid

string

Returns

Promise<void>

Implementation of

RedTeamService.deleteTarget

---

getAdapter()

getAdapter(uuid): Promise<RedTeamAdapterDetail>

Defined in: src/airs/redteam.ts:779

Parameters

uuid

string

Returns

Promise<RedTeamAdapterDetail>

Implementation of

RedTeamService.getAdapter

---

getCategories()

getCategories(): Promise<RedTeamCategory[]>

Defined in: src/airs/redteam.ts:631

List available attack categories.

Returns

Promise<RedTeamCategory[]>

Implementation of

RedTeamService.getCategories

---

getChannel()

getChannel(channelId): Promise<RedTeamChannel>

Defined in: src/airs/redteam.ts:684

Get a network broker channel by ID.

Parameters

channelId

string

Returns

Promise<RedTeamChannel>

Implementation of

RedTeamService.getChannel

---

getChannelStats()

getChannelStats(): Promise<RedTeamChannelStats>

Defined in: src/airs/redteam.ts:712

Get network broker channel statistics.

Returns

Promise<RedTeamChannelStats>

Implementation of

RedTeamService.getChannelStats

---

getCustomReport()

getCustomReport(jobId): Promise<RedTeamCustomReport>

Defined in: src/airs/redteam.ts:568

Get custom attack report.

Parameters

jobId

string

Returns

Promise<RedTeamCustomReport>

Implementation of

RedTeamService.getCustomReport

---

getDynamicReport()

getDynamicReport(jobId): Promise<RedTeamDynamicReport>

Defined in: src/airs/redteam.ts:555

Get dynamic scan report.

Parameters

jobId

string

Returns

Promise<RedTeamDynamicReport>

Implementation of

RedTeamService.getDynamicReport

---

getEulaContent()

getEulaContent(): Promise<EulaContent>

Defined in: src/airs/redteam.ts:241

Get EULA content.

Returns

Promise<EulaContent>

Implementation of

RedTeamService.getEulaContent

---

getEulaStatus()

getEulaStatus(): Promise<EulaStatus>

Defined in: src/airs/redteam.ts:246

Get EULA acceptance status.

Returns

Promise<EulaStatus>

Implementation of

RedTeamService.getEulaStatus

---

getInstance()

getInstance(tenantId): Promise<InstanceDetail>

Defined in: src/airs/redteam.ts:282

Get instance details.

Parameters

tenantId

string

Returns

Promise<InstanceDetail>

Implementation of

RedTeamService.getInstance

---

getLanguages()

getLanguages(management?): Promise<RedTeamLanguages>

Defined in: src/airs/redteam.ts:725

List tenant languages (data plane, or management plane when management).

Parameters

management?

boolean = false

Returns

Promise<RedTeamLanguages>

Implementation of

RedTeamService.getLanguages

---

getRegistryCredentials()

getRegistryCredentials(): Promise<RegistryCredentials>

Defined in: src/airs/redteam.ts:344

Get or create registry credentials.

Returns

Promise<RegistryCredentials>

Implementation of

RedTeamService.getRegistryCredentials

---

getScan()

getScan(jobId): Promise<RedTeamJob>

Defined in: src/airs/redteam.ts:495

Get scan status by job ID.

Parameters

jobId

string

Returns

Promise<RedTeamJob>

Implementation of

RedTeamService.getScan

---

getStaticReport()

getStaticReport(jobId): Promise<RedTeamStaticReport>

Defined in: src/airs/redteam.ts:522

Get static scan report.

Parameters

jobId

string

Returns

Promise<RedTeamStaticReport>

Implementation of

RedTeamService.getStaticReport

---

getTarget()

getTarget(uuid): Promise<RedTeamTargetDetail>

Defined in: src/airs/redteam.ts:407

Get target details.

Parameters

uuid

string

Returns

Promise<RedTeamTargetDetail>

Implementation of

RedTeamService.getTarget

---

getTargetMetadata()

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

Defined in: src/airs/redteam.ts:371

Get target field metadata.

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.getTargetMetadata

---

getTargetProfile()

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

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

Get target profile.

Parameters

uuid

string

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.getTargetProfile

---

getTargetProfileErrorLogs()

getTargetProfileErrorLogs(targetId, opts?): Promise<{ logs: RedTeamErrorLog[]; totalItems?: number; }>

Defined in: src/airs/redteam.ts:739

List target-profile error logs.

Parameters

targetId

string

opts?

limit?

number

offset?

number

search?

string

Returns

Promise<{ logs: RedTeamErrorLog[]; totalItems?: number; }>

Implementation of

RedTeamService.getTargetProfileErrorLogs

---

getTargetTemplates()

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

Defined in: src/airs/redteam.ts:375

Get provider-specific target templates.

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.getTargetTemplates

---

listAdapters()

listAdapters(opts?): Promise<{ adapters: RedTeamAdapterListItem[]; totalItems?: number; }>

Defined in: src/airs/redteam.ts:763

Parameters

opts?

RedTeamAdapterListOptions

Returns

Promise<{ adapters: RedTeamAdapterListItem[]; totalItems?: number; }>

Implementation of

RedTeamService.listAdapters

---

listAttacks()

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

Defined in: src/airs/redteam.ts:590

List attacks from a static/dynamic scan.

Parameters

jobId

string

opts?

limit?

number

severity?

string

Returns

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

Implementation of

RedTeamService.listAttacks

---

listChannels()

listChannels(opts?): Promise<{ channels: RedTeamChannel[]; totalItems?: number; }>

Defined in: src/airs/redteam.ts:667

List network broker channels.

Parameters

opts?

RedTeamChannelListOptions

Returns

Promise<{ channels: RedTeamChannel[]; totalItems?: number; }>

Implementation of

RedTeamService.listChannels

---

listCustomAttacks()

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

Defined in: src/airs/redteam.ts:614

List attacks from a custom prompt set scan.

Parameters

jobId

string

opts?

limit?

number

Returns

Promise<RedTeamCustomAttack[]>

Implementation of

RedTeamService.listCustomAttacks

---

listScans()

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

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

List recent scans with optional filters.

Parameters

opts?

jobType?

string

limit?

number

status?

string

targetId?

string

Returns

Promise<RedTeamJob[]>

Implementation of

RedTeamService.listScans

---

listTargets()

listTargets(): Promise<RedTeamTarget[]>

Defined in: src/airs/redteam.ts:379

List configured red team targets.

Returns

Promise<RedTeamTarget[]>

Implementation of

RedTeamService.listTargets

---

probeTarget()

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

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

Probe a target connection.

Parameters

request

Record<string, unknown>

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.probeTarget

---

updateAdapter()

updateAdapter(uuid, overrides, validate?): Promise<RedTeamAdapterDetail>

Defined in: src/airs/redteam.ts:807

Read-modify-write: merges overrides onto the current record (upstream PUT is full-replacement).

Parameters

uuid

string

overrides

RedTeamAdapterUpdateOverrides

validate?

boolean

Returns

Promise<RedTeamAdapterDetail>

Implementation of

RedTeamService.updateAdapter

---

updateChannel()

updateChannel(channelId, request): Promise<RedTeamChannel>

Defined in: src/airs/redteam.ts:698

Update a network broker channel.

Parameters

channelId

string

request

RedTeamChannelUpdateRequest

Returns

Promise<RedTeamChannel>

Implementation of

RedTeamService.updateChannel

---

updateDevices()

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

Defined in: src/airs/redteam.ts:327

Update devices (PATCH).

Parameters

tenantId

string

request

Record<string, unknown>

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.updateDevices

---

updateInstance()

updateInstance(tenantId, request): Promise<InstanceResponse>

Defined in: src/airs/redteam.ts:292

Update an instance.

Parameters

tenantId

string

request

InstanceRequest

Returns

Promise<InstanceResponse>

Implementation of

RedTeamService.updateInstance

---

updateTarget()

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

Defined in: src/airs/redteam.ts:420

Update a red team target.

Parameters

uuid

string

request

RedTeamTargetUpdateRequest

opts?

TargetOperationOptions

Returns

Promise<RedTeamTargetDetail>

Implementation of

RedTeamService.updateTarget

---

updateTargetProfile()

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

Defined in: src/airs/redteam.ts:448

Update target profile.

Parameters

uuid

string

request

Record<string, unknown>

Returns

Promise<Record<string, unknown>>

Implementation of

RedTeamService.updateTargetProfile

---

validateAdapter()

validateAdapter(request): Promise<RedTeamAdapterValidationResult>

Defined in: src/airs/redteam.ts:842

Run a script end-to-end through the broker channel; returns an execution outcome.

Parameters

request

RedTeamAdapterValidateRequest

Returns

Promise<RedTeamAdapterValidationResult>

Implementation of

RedTeamService.validateAdapter

---

validateTargetAuth()

validateTargetAuth(request): Promise<TargetAuthValidationResult>

Defined in: src/airs/redteam.ts:352

Validate target auth credentials.

Parameters

request

TargetAuthValidationRequest

Returns

Promise<TargetAuthValidationResult>

Implementation of

RedTeamService.validateTargetAuth

---

waitForCompletion()

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

Defined in: src/airs/redteam.ts:645

Poll until scan completes. Calls onProgress for status updates.

Parameters

jobId

string

onProgress?

(job) => void

intervalMs?

number = 5000

Returns

Promise<RedTeamJob>

Implementation of

RedTeamService.waitForCompletion