Class: RedTeamTargetsClient

Defined in: src/red-team/targets-client.ts:77

Client for Red Team management plane target operations.

Constructors

Constructor

new RedTeamTargetsClient(opts): RedTeamTargetsClient;

Defined in: src/red-team/targets-client.ts:137

Parameters

Parameter	Type
opts	RedTeamTargetsClientOptions

Returns

RedTeamTargetsClient

Methods

startProfiling()

startProfiling(uuid): Promise<objectOutputType<{
  message: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:79

Trigger profiling of an active target.

Parameters

Parameter	Type
uuid	string

Returns

Promise<objectOutputType<{ message: ZodString; }, ZodTypeAny, "passthrough">>

Example

`await rt.targets.startProfiling(targetUuid);`

---

getCopilotAuthUrl()

getCopilotAuthUrl(body): Promise<objectOutputType<{
  auth_url: ZodString;
  token_json_uuid: ZodString;
  state: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:91

Begin Copilot Studio OAuth authorization.

Parameters

Parameter	Type
body	{ client_id: string; client_secret: string; tenant_id: string; target_uuid?: string | null; token_json_uuid?: string | null; }
body.client_id	string
body.client_secret	string
body.tenant_id	string
body.target_uuid?	string | null
body.token_json_uuid?	string | null

Returns

Promise<objectOutputType<{ auth_url: ZodString; token_json_uuid: ZodString; state: ZodString; }, ZodTypeAny, "passthrough">>

Example

`const auth = await rt.targets.getCopilotAuthUrl({ client_id, client_secret, tenant_id });`

---

exchangeCopilotToken()

exchangeCopilotToken(body): Promise<objectOutputType<{
  token_json_uuid: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:107

Exchange the Copilot callback and state for a stored token reference.

Parameters

Parameter	Type
body	{ auth_response: Record<string, string>; token_json_uuid: string; client_id: string; client_secret: string; tenant_id: string; target_uuid?: string | null; }
body.auth_response	Record<string, string>
body.token_json_uuid	string
body.client_id	string
body.client_secret	string
body.tenant_id	string
body.target_uuid?	string | null

Returns

Promise<objectOutputType<{ token_json_uuid: ZodString; }, ZodTypeAny, "passthrough">>

Example

`const token = await rt.targets.exchangeCopilotToken({ auth_response: { code, state }, token_json_uuid, client_id, client_secret, tenant_id });`

---

deleteCopilotToken()

deleteCopilotToken(uuid): Promise<void>;

Defined in: src/red-team/targets-client.ts:123

Delete a Copilot token reference when cancelling authorization.

Parameters

Parameter	Type
uuid	string

Returns

Promise<void>

Example

`await rt.targets.deleteCopilotToken(tokenUuid);`

---

create()

create(body, opts?): Promise<objectOutputType<{
  adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
  connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     ws_response_timeout: ZodDefault<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     response_stop_key: ZodString;
     response_stop_value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<ZodBoolean>;
     api_endpoint: ZodOptional<ZodNullable<...>>;
     request_headers: ZodOptional<ZodNullable<...>>;
     request_json: ZodOptional<ZodNullable<...>>;
     response_json: ZodOptional<ZodNullable<...>>;
     response_key: ZodOptional<ZodNullable<...>>;
     target_connection_config: ZodOptional<ZodNullable<...>>;
     curl: ZodOptional<ZodNullable<...>>;
     multi_turn_config: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     auth_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     basic_auth_location: ZodDefault<ZodString>;
     basic_auth_header: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<ZodNumber>;
     oauth2_headers: ZodOptional<ZodRecord<..., ...>>;
     oauth2_body_params: ZodOptional<ZodRecord<..., ...>>;
     oauth2_token_response_key: ZodDefault<ZodString>;
     oauth2_inject_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodOptional<ZodNullable<...>>;
     type: ZodEnum<[..., ...]>;
   } & {
     is_redacted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  uuid: ZodString;
  tsg_id: ZodString;
  name: ZodString;
  status: ZodString;
  active: ZodBoolean;
  validated: ZodBoolean;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodOptional<ZodNullable<ZodString>>;
  target_type: ZodOptional<ZodNullable<ZodString>>;
  connection_type: ZodOptional<ZodNullable<ZodString>>;
  api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
  response_mode: ZodOptional<ZodNullable<ZodString>>;
  session_supported: ZodOptional<ZodBoolean>;
  extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  secret_version: ZodOptional<ZodNullable<ZodString>>;
  created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  target_metadata: ZodOptional<ZodObject<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>;
  target_background: ZodOptional<ZodNullable<ZodObject<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  profiling_status: ZodOptional<ZodNullable<ZodString>>;
  additional_context: ZodOptional<ZodNullable<ZodObject<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:168

Create a new target.

Parameters

Parameter	Type	Description
body	{ name: string; description?: string | null; target_type?: "AGENT" | "APPLICATION" | "MODEL" | null; connection_type?: | "CUSTOM" | "HUGGING_FACE" | "CUSTOM_TARGET_ADAPTER" | "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | "DATABRICKS" | "BEDROCK" | "OPENAI" | "MS_COPILOT_STUDIO" | null; api_endpoint_type?: "PUBLIC" | "PRIVATE" | "NETWORK_BROKER" | null; response_mode?: "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | null; connection_params?: | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { ws_response_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null; auth_config?: | objectOutputType<{ auth_header: ZodRecord<ZodString, ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ oauth2_token_url: ZodString; oauth2_headers: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_body_params: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; } & { oauth2_expiry_minutes: ZodOptional<ZodNumber>; oauth2_token_response_key: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ basic_auth_header: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>; } & { basic_auth_location: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null; auth_type?: "HEADERS" | "BASIC_AUTH" | "OAUTH2" | "CUSTOM_TARGET_ADAPTER" | null; canonical_id?: string | null; session_supported?: boolean; target_metadata?: objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">; target_background?: | objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null; additional_context?: | objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null; extra_info?: Record<string, unknown> | null; network_broker_channel_uuid?: string | null; adapter_uuid?: string | null; adapter_variable_overrides?: | { key: string; value?: string | null; type: "VAR" | "SECRET"; }[] | null; }	Target creation request body.
body.name	string	-
body.description?	string | null	-
body.target_type?	"AGENT" | "APPLICATION" | "MODEL" | null	-
body.connection_type?	| "CUSTOM" | "HUGGING_FACE" | "CUSTOM_TARGET_ADAPTER" | "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | "DATABRICKS" | "BEDROCK" | "OPENAI" | "MS_COPILOT_STUDIO" | null	-
body.api_endpoint_type?	"PUBLIC" | "PRIVATE" | "NETWORK_BROKER" | null	-
body.response_mode?	"REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | null	-
body.connection_params?	| objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { ws_response_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null	-
body.auth_config?	| objectOutputType<{ auth_header: ZodRecord<ZodString, ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ oauth2_token_url: ZodString; oauth2_headers: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_body_params: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; } & { oauth2_expiry_minutes: ZodOptional<ZodNumber>; oauth2_token_response_key: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ basic_auth_header: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>; } & { basic_auth_location: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null	-
body.auth_type?	"HEADERS" | "BASIC_AUTH" | "OAUTH2" | "CUSTOM_TARGET_ADAPTER" | null	-
body.canonical_id?	string | null	-
body.session_supported?	boolean	-
body.target_metadata?	objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">	-
body.target_background?	| objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null	-
body.additional_context?	| objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null	-
body.extra_info?	Record<string, unknown> | null	-
body.network_broker_channel_uuid?	string | null	-
body.adapter_uuid?	string | null	UUID of the custom target adapter to use. Required when connection_type is CUSTOM_TARGET_ADAPTER.
body.adapter_variable_overrides?	| { key: string; value?: string | null; type: "VAR" | "SECRET"; }[] | null	Per-target overrides for the adapter's variables. Array of AdapterVar objects.
opts?	TargetOperationOptions	Optional operation options (e.g. validate connection).

Returns

Promise<objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>; connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { ws_response_timeout: ZodDefault<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<...>>; request_headers: ZodOptional<ZodNullable<...>>; request_json: ZodOptional<ZodNullable<...>>; response_json: ZodOptional<ZodNullable<...>>; response_key: ZodOptional<ZodNullable<...>>; target_connection_config: ZodOptional<ZodNullable<...>>; curl: ZodOptional<ZodNullable<...>>; multi_turn_config: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">>]>>>; auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ auth_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ basic_auth_location: ZodDefault<ZodString>; basic_auth_header: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<ZodNumber>; oauth2_headers: ZodOptional<ZodRecord<..., ...>>; oauth2_body_params: ZodOptional<ZodRecord<..., ...>>; oauth2_token_response_key: ZodDefault<ZodString>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>]>>>; network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ZodString; value: ZodOptional<ZodNullable<...>>; type: ZodEnum<[..., ...]>; } & { is_redacted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; target_metadata: ZodOptional<ZodObject<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>; target_background: ZodOptional<ZodNullable<ZodObject<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; profiling_status: ZodOptional<ZodNullable<ZodString>>; additional_context: ZodOptional<ZodNullable<ZodObject<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The created target response.

Example

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

const target = await rt.targets.create(
  {
    name: 'prod-chatbot',
    target_type: 'API',
    connection_params: {
      api_endpoint: 'https://api.openai.com/v1/responses',
      response_key: 'output[0].content[0].text',
    },
  },
  { validate: true },
);
// target =>
// { uuid: '550e8400-...', name: 'prod-chatbot', status: 'VALIDATED', active: true, validated: true }

---

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">>;
  data: ZodOptional<ZodArray<ZodObject<{
     adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     profiling_status: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     uuid: ZodString;
     tsg_id: ZodString;
     name: ZodString;
     status: ZodString;
     active: ZodBoolean;
     validated: ZodBoolean;
     created_at: ZodString;
     updated_at: ZodString;
     description: ZodOptional<ZodNullable<ZodString>>;
     target_type: ZodOptional<ZodNullable<ZodString>>;
     connection_type: ZodOptional<ZodNullable<ZodString>>;
     api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
     response_mode: ZodOptional<ZodNullable<ZodString>>;
     session_supported: ZodOptional<ZodBoolean>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     secret_version: ZodOptional<ZodNullable<ZodString>>;
     created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
     updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
     auth_type: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     adapter_uuid: ZodOptional<ZodUnion<[..., ...]>>;
     profiling_status: ZodOptional<ZodUnion<[..., ...]>>;
     canonical_id: ZodOptional<ZodUnion<[..., ...]>>;
     uuid: ZodString;
     tsg_id: ZodString;
     name: ZodString;
     status: ZodString;
     active: ZodBoolean;
     validated: ZodBoolean;
     created_at: ZodString;
     updated_at: ZodString;
     description: ZodOptional<ZodNullable<ZodString>>;
     target_type: ZodOptional<ZodNullable<ZodString>>;
     connection_type: ZodOptional<ZodNullable<ZodString>>;
     api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
     response_mode: ZodOptional<ZodNullable<ZodString>>;
     session_supported: ZodOptional<ZodBoolean>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     secret_version: ZodOptional<ZodNullable<ZodString>>;
     created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
     updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
     auth_type: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     adapter_uuid: ZodOptional<ZodUnion<[..., ...]>>;
     profiling_status: ZodOptional<ZodUnion<[..., ...]>>;
     canonical_id: ZodOptional<ZodUnion<[..., ...]>>;
     uuid: ZodString;
     tsg_id: ZodString;
     name: ZodString;
     status: ZodString;
     active: ZodBoolean;
     validated: ZodBoolean;
     created_at: ZodString;
     updated_at: ZodString;
     description: ZodOptional<ZodNullable<ZodString>>;
     target_type: ZodOptional<ZodNullable<ZodString>>;
     connection_type: ZodOptional<ZodNullable<ZodString>>;
     api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
     response_mode: ZodOptional<ZodNullable<ZodString>>;
     session_supported: ZodOptional<ZodBoolean>;
     extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>;
     version: ZodOptional<ZodNullable<ZodNumber>>;
     secret_version: ZodOptional<ZodNullable<ZodString>>;
     created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
     updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
     auth_type: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:199

List targets with optional filters.

Parameters

Parameter	Type	Description
opts?	TargetListOptions	Optional pagination, search, 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">>; data: ZodOptional<ZodArray<ZodObject<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_status: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[..., ...]>>; profiling_status: ZodOptional<ZodUnion<[..., ...]>>; canonical_id: ZodOptional<ZodUnion<[..., ...]>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ adapter_uuid: ZodOptional<ZodUnion<[..., ...]>>; profiling_status: ZodOptional<ZodUnion<[..., ...]>>; canonical_id: ZodOptional<ZodUnion<[..., ...]>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<..., ...>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>, "many">>; }, ZodTypeAny, "passthrough">>

The paginated list of targets.

Example

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

const targets = await rt.targets.list({ limit: 10, target_type: 'API' });
// targets =>
// { pagination: { total_items: 4 }, data: [{ uuid: '550e8400-...', name: 'prod-chatbot', status: 'READY' }] }

---

listAll()

listAll(opts?): Promise<objectOutputType<{
  adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_status: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  uuid: ZodString;
  tsg_id: ZodString;
  name: ZodString;
  status: ZodString;
  active: ZodBoolean;
  validated: ZodBoolean;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodOptional<ZodNullable<ZodString>>;
  target_type: ZodOptional<ZodNullable<ZodString>>;
  connection_type: ZodOptional<ZodNullable<ZodString>>;
  api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
  response_mode: ZodOptional<ZodNullable<ZodString>>;
  session_supported: ZodOptional<ZodBoolean>;
  extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  secret_version: ZodOptional<ZodNullable<ZodString>>;
  created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">[]>;

Defined in: src/red-team/targets-client.ts:226

List targets across every page while preserving the supplied filters.

Parameters

Parameter	Type
opts	TargetListAllOptions

Returns

Promise<objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_status: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">[]>

Example

const targets = await rt.targets.listAll({ limit: 100, status: 'READY' });

---

get()

get(uuid): Promise<objectOutputType<{
  adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
  connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     ws_response_timeout: ZodDefault<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     response_stop_key: ZodString;
     response_stop_value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<ZodBoolean>;
     api_endpoint: ZodOptional<ZodNullable<...>>;
     request_headers: ZodOptional<ZodNullable<...>>;
     request_json: ZodOptional<ZodNullable<...>>;
     response_json: ZodOptional<ZodNullable<...>>;
     response_key: ZodOptional<ZodNullable<...>>;
     target_connection_config: ZodOptional<ZodNullable<...>>;
     curl: ZodOptional<ZodNullable<...>>;
     multi_turn_config: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     auth_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     basic_auth_location: ZodDefault<ZodString>;
     basic_auth_header: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<ZodNumber>;
     oauth2_headers: ZodOptional<ZodRecord<..., ...>>;
     oauth2_body_params: ZodOptional<ZodRecord<..., ...>>;
     oauth2_token_response_key: ZodDefault<ZodString>;
     oauth2_inject_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodOptional<ZodNullable<...>>;
     type: ZodEnum<[..., ...]>;
   } & {
     is_redacted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  uuid: ZodString;
  tsg_id: ZodString;
  name: ZodString;
  status: ZodString;
  active: ZodBoolean;
  validated: ZodBoolean;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodOptional<ZodNullable<ZodString>>;
  target_type: ZodOptional<ZodNullable<ZodString>>;
  connection_type: ZodOptional<ZodNullable<ZodString>>;
  api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
  response_mode: ZodOptional<ZodNullable<ZodString>>;
  session_supported: ZodOptional<ZodBoolean>;
  extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  secret_version: ZodOptional<ZodNullable<ZodString>>;
  created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  target_metadata: ZodOptional<ZodObject<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>;
  target_background: ZodOptional<ZodNullable<ZodObject<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  profiling_status: ZodOptional<ZodNullable<ZodString>>;
  additional_context: ZodOptional<ZodNullable<ZodObject<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:260

Get a target by UUID.

Parameters

Parameter	Type	Description
uuid	string	The target UUID.

Returns

Promise<objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>; connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { ws_response_timeout: ZodDefault<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<...>>; request_headers: ZodOptional<ZodNullable<...>>; request_json: ZodOptional<ZodNullable<...>>; response_json: ZodOptional<ZodNullable<...>>; response_key: ZodOptional<ZodNullable<...>>; target_connection_config: ZodOptional<ZodNullable<...>>; curl: ZodOptional<ZodNullable<...>>; multi_turn_config: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">>]>>>; auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ auth_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ basic_auth_location: ZodDefault<ZodString>; basic_auth_header: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<ZodNumber>; oauth2_headers: ZodOptional<ZodRecord<..., ...>>; oauth2_body_params: ZodOptional<ZodRecord<..., ...>>; oauth2_token_response_key: ZodDefault<ZodString>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>]>>>; network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ZodString; value: ZodOptional<ZodNullable<...>>; type: ZodEnum<[..., ...]>; } & { is_redacted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; target_metadata: ZodOptional<ZodObject<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>; target_background: ZodOptional<ZodNullable<ZodObject<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; profiling_status: ZodOptional<ZodNullable<ZodString>>; additional_context: ZodOptional<ZodNullable<ZodObject<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The target response.

Example

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

const target = await rt.targets.get('550e8400-e29b-41d4-a716-446655440000');
// target =>
// { uuid: '550e8400-...', name: 'prod-chatbot', status: 'READY', active: true, validated: true }

---

update()

update(
   uuid, 
   body, 
   opts?): Promise<objectOutputType<{
  adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
  connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     ws_response_timeout: ZodDefault<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     response_stop_key: ZodString;
     response_stop_value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<ZodBoolean>;
     api_endpoint: ZodOptional<ZodNullable<...>>;
     request_headers: ZodOptional<ZodNullable<...>>;
     request_json: ZodOptional<ZodNullable<...>>;
     response_json: ZodOptional<ZodNullable<...>>;
     response_key: ZodOptional<ZodNullable<...>>;
     target_connection_config: ZodOptional<ZodNullable<...>>;
     curl: ZodOptional<ZodNullable<...>>;
     multi_turn_config: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     auth_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     basic_auth_location: ZodDefault<ZodString>;
     basic_auth_header: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<ZodNumber>;
     oauth2_headers: ZodOptional<ZodRecord<..., ...>>;
     oauth2_body_params: ZodOptional<ZodRecord<..., ...>>;
     oauth2_token_response_key: ZodDefault<ZodString>;
     oauth2_inject_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodOptional<ZodNullable<...>>;
     type: ZodEnum<[..., ...]>;
   } & {
     is_redacted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  uuid: ZodString;
  tsg_id: ZodString;
  name: ZodString;
  status: ZodString;
  active: ZodBoolean;
  validated: ZodBoolean;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodOptional<ZodNullable<ZodString>>;
  target_type: ZodOptional<ZodNullable<ZodString>>;
  connection_type: ZodOptional<ZodNullable<ZodString>>;
  api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
  response_mode: ZodOptional<ZodNullable<ZodString>>;
  session_supported: ZodOptional<ZodBoolean>;
  extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  secret_version: ZodOptional<ZodNullable<ZodString>>;
  created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  target_metadata: ZodOptional<ZodObject<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>;
  target_background: ZodOptional<ZodNullable<ZodObject<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  profiling_status: ZodOptional<ZodNullable<ZodString>>;
  additional_context: ZodOptional<ZodNullable<ZodObject<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:292

Update a target.

Parameters

Parameter	Type	Description
uuid	string	The target UUID.
body	{ name: string; description?: string | null; target_type?: "AGENT" | "APPLICATION" | "MODEL" | null; connection_type?: | "CUSTOM" | "HUGGING_FACE" | "CUSTOM_TARGET_ADAPTER" | "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | "DATABRICKS" | "BEDROCK" | "OPENAI" | "MS_COPILOT_STUDIO" | null; api_endpoint_type?: "PUBLIC" | "PRIVATE" | "NETWORK_BROKER" | null; response_mode?: "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | null; connection_params?: | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { ws_response_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null; auth_config?: | objectOutputType<{ auth_header: ZodRecord<ZodString, ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ oauth2_token_url: ZodString; oauth2_headers: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_body_params: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; } & { oauth2_expiry_minutes: ZodOptional<ZodNumber>; oauth2_token_response_key: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ basic_auth_header: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>; } & { basic_auth_location: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null; auth_type?: "HEADERS" | "BASIC_AUTH" | "OAUTH2" | "CUSTOM_TARGET_ADAPTER" | null; canonical_id?: string | null; session_supported?: boolean; target_metadata?: objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">; target_background?: | objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null; additional_context?: | objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null; extra_info?: Record<string, unknown> | null; network_broker_channel_uuid?: string | null; adapter_uuid?: string | null; adapter_variable_overrides?: | { key: string; value?: string | null; type: "VAR" | "SECRET"; }[] | null; }	Target update request body.
body.name	string	-
body.description?	string | null	-
body.target_type?	"AGENT" | "APPLICATION" | "MODEL" | null	-
body.connection_type?	| "CUSTOM" | "HUGGING_FACE" | "CUSTOM_TARGET_ADAPTER" | "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | "DATABRICKS" | "BEDROCK" | "OPENAI" | "MS_COPILOT_STUDIO" | null	-
body.api_endpoint_type?	"PUBLIC" | "PRIVATE" | "NETWORK_BROKER" | null	-
body.response_mode?	"REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | null	-
body.connection_params?	| objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { ws_response_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null	-
body.auth_config?	| objectOutputType<{ auth_header: ZodRecord<ZodString, ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ oauth2_token_url: ZodString; oauth2_headers: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_body_params: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; } & { oauth2_expiry_minutes: ZodOptional<ZodNumber>; oauth2_token_response_key: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ basic_auth_header: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>; } & { basic_auth_location: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null	-
body.auth_type?	"HEADERS" | "BASIC_AUTH" | "OAUTH2" | "CUSTOM_TARGET_ADAPTER" | null	-
body.canonical_id?	string | null	-
body.session_supported?	boolean	-
body.target_metadata?	objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">	-
body.target_background?	| objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null	-
body.additional_context?	| objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null	-
body.extra_info?	Record<string, unknown> | null	-
body.network_broker_channel_uuid?	string | null	-
body.adapter_uuid?	string | null	UUID of the custom target adapter to use. Required when connection_type is CUSTOM_TARGET_ADAPTER.
body.adapter_variable_overrides?	| { key: string; value?: string | null; type: "VAR" | "SECRET"; }[] | null	Per-target overrides for the adapter's variables. Array of AdapterVar objects.
opts?	TargetOperationOptions	Optional operation options (e.g. validate connection).

Returns

Promise<objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>; connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { ws_response_timeout: ZodDefault<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<...>>; request_headers: ZodOptional<ZodNullable<...>>; request_json: ZodOptional<ZodNullable<...>>; response_json: ZodOptional<ZodNullable<...>>; response_key: ZodOptional<ZodNullable<...>>; target_connection_config: ZodOptional<ZodNullable<...>>; curl: ZodOptional<ZodNullable<...>>; multi_turn_config: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">>]>>>; auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ auth_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ basic_auth_location: ZodDefault<ZodString>; basic_auth_header: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<ZodNumber>; oauth2_headers: ZodOptional<ZodRecord<..., ...>>; oauth2_body_params: ZodOptional<ZodRecord<..., ...>>; oauth2_token_response_key: ZodDefault<ZodString>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>]>>>; network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ZodString; value: ZodOptional<ZodNullable<...>>; type: ZodEnum<[..., ...]>; } & { is_redacted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; target_metadata: ZodOptional<ZodObject<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>; target_background: ZodOptional<ZodNullable<ZodObject<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; profiling_status: ZodOptional<ZodNullable<ZodString>>; additional_context: ZodOptional<ZodNullable<ZodObject<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The updated target response.

Example

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

const target = await rt.targets.update(
  '550e8400-e29b-41d4-a716-446655440000',
  { name: 'prod-chatbot-v2' },
  { validate: false },
);
// target =>
// { uuid: '550e8400-...', name: 'prod-chatbot-v2', status: 'READY', updated_at: '2026-03-08T10:00:00Z' }

---

delete()

delete(uuid): Promise<
  | objectOutputType<{
  message: ZodString;
  status: ZodNumber;
}, ZodTypeAny, "passthrough">
| undefined>;

Defined in: src/red-team/targets-client.ts:328

Delete a target.

Parameters

Parameter	Type	Description
uuid	string	The target UUID.

Returns

Promise< | objectOutputType<{ message: ZodString; status: ZodNumber; }, ZodTypeAny, "passthrough"> | undefined>

The delete response.

Example

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

const result = await rt.targets.delete('550e8400-e29b-41d4-a716-446655440000');
// result =>
// { message: 'ok', status: 200 }

---

probe()

probe(body): Promise<objectOutputType<{
  adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
  connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     ws_response_timeout: ZodDefault<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     response_stop_key: ZodString;
     response_stop_value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<ZodBoolean>;
     api_endpoint: ZodOptional<ZodNullable<...>>;
     request_headers: ZodOptional<ZodNullable<...>>;
     request_json: ZodOptional<ZodNullable<...>>;
     response_json: ZodOptional<ZodNullable<...>>;
     response_key: ZodOptional<ZodNullable<...>>;
     target_connection_config: ZodOptional<ZodNullable<...>>;
     curl: ZodOptional<ZodNullable<...>>;
     multi_turn_config: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     auth_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     basic_auth_location: ZodDefault<ZodString>;
     basic_auth_header: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<ZodNumber>;
     oauth2_headers: ZodOptional<ZodRecord<..., ...>>;
     oauth2_body_params: ZodOptional<ZodRecord<..., ...>>;
     oauth2_token_response_key: ZodDefault<ZodString>;
     oauth2_inject_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodOptional<ZodNullable<...>>;
     type: ZodEnum<[..., ...]>;
   } & {
     is_redacted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  uuid: ZodString;
  tsg_id: ZodString;
  name: ZodString;
  status: ZodString;
  active: ZodBoolean;
  validated: ZodBoolean;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodOptional<ZodNullable<ZodString>>;
  target_type: ZodOptional<ZodNullable<ZodString>>;
  connection_type: ZodOptional<ZodNullable<ZodString>>;
  api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
  response_mode: ZodOptional<ZodNullable<ZodString>>;
  session_supported: ZodOptional<ZodBoolean>;
  extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  secret_version: ZodOptional<ZodNullable<ZodString>>;
  created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  target_metadata: ZodOptional<ZodObject<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>;
  target_background: ZodOptional<ZodNullable<ZodObject<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  profiling_status: ZodOptional<ZodNullable<ZodString>>;
  additional_context: ZodOptional<ZodNullable<ZodObject<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:359

Run profiling probes on a target.

Parameters

Parameter	Type	Description
body	{ name: string; description?: string | null; target_type?: "AGENT" | "APPLICATION" | "MODEL" | null; connection_type?: | "CUSTOM" | "HUGGING_FACE" | "CUSTOM_TARGET_ADAPTER" | "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | "DATABRICKS" | "BEDROCK" | "OPENAI" | "MS_COPILOT_STUDIO" | null; api_endpoint_type?: "PUBLIC" | "PRIVATE" | "NETWORK_BROKER" | null; response_mode?: "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | null; connection_params?: | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { ws_response_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null; auth_config?: | objectOutputType<{ auth_header: ZodRecord<ZodString, ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ oauth2_token_url: ZodString; oauth2_headers: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_body_params: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; } & { oauth2_expiry_minutes: ZodOptional<ZodNumber>; oauth2_token_response_key: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ basic_auth_header: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>; } & { basic_auth_location: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null; auth_type?: "HEADERS" | "BASIC_AUTH" | "OAUTH2" | "CUSTOM_TARGET_ADAPTER" | null; canonical_id?: string | null; session_supported?: boolean; target_metadata?: objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">; target_background?: | objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null; additional_context?: | objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null; extra_info?: Record<string, unknown> | null; network_broker_channel_uuid?: string | null; adapter_uuid?: string | null; adapter_variable_overrides?: | { key: string; value?: string | null; type: "VAR" | "SECRET"; }[] | null; uuid?: string | null; probe_fields?: string[] | null; }	The probe request body.
body.name	string	-
body.description?	string | null	-
body.target_type?	"AGENT" | "APPLICATION" | "MODEL" | null	-
body.connection_type?	| "CUSTOM" | "HUGGING_FACE" | "CUSTOM_TARGET_ADAPTER" | "REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | "DATABRICKS" | "BEDROCK" | "OPENAI" | "MS_COPILOT_STUDIO" | null	-
body.api_endpoint_type?	"PUBLIC" | "PRIVATE" | "NETWORK_BROKER" | null	-
body.response_mode?	"REST" | "STREAMING" | "WEBSOCKET" | "WEBSOCKET_STREAMING" | null	-
body.connection_params?	| objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, ZodTypeAny, "passthrough"> | objectOutputType<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<ZodString>>; request_headers: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; request_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; response_key: ZodOptional<ZodNullable<ZodString>>; target_connection_config: ZodOptional<ZodNullable<ZodType<TargetConnectionConfig, ZodTypeDef, TargetConnectionConfig>>>; curl: ZodOptional<ZodNullable<ZodString>>; multi_turn_config: ZodOptional<ZodNullable<ZodType<MultiTurnConfig, ZodTypeDef, MultiTurnConfig>>>; } & { ws_response_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough"> | null	-
body.auth_config?	| objectOutputType<{ auth_header: ZodRecord<ZodString, ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ oauth2_token_url: ZodString; oauth2_headers: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_body_params: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; } & { oauth2_expiry_minutes: ZodOptional<ZodNumber>; oauth2_token_response_key: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | objectOutputType<{ basic_auth_header: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodString>>>; } & { basic_auth_location: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough"> | null	-
body.auth_type?	"HEADERS" | "BASIC_AUTH" | "OAUTH2" | "CUSTOM_TARGET_ADAPTER" | null	-
body.canonical_id?	string | null	-
body.session_supported?	boolean	-
body.target_metadata?	objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">	-
body.target_background?	| objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null	-
body.additional_context?	| objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, ZodTypeAny, "passthrough"> | null	-
body.extra_info?	Record<string, unknown> | null	-
body.network_broker_channel_uuid?	string | null	-
body.adapter_uuid?	string | null	UUID of the custom target adapter to use. Required when connection_type is CUSTOM_TARGET_ADAPTER.
body.adapter_variable_overrides?	| { key: string; value?: string | null; type: "VAR" | "SECRET"; }[] | null	Per-target overrides for the adapter's variables. Array of AdapterVar objects.
body.uuid?	string | null	-
body.probe_fields?	string[] | null	-

Returns

Promise<objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>; connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { ws_response_timeout: ZodDefault<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<...>>; request_headers: ZodOptional<ZodNullable<...>>; request_json: ZodOptional<ZodNullable<...>>; response_json: ZodOptional<ZodNullable<...>>; response_key: ZodOptional<ZodNullable<...>>; target_connection_config: ZodOptional<ZodNullable<...>>; curl: ZodOptional<ZodNullable<...>>; multi_turn_config: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">>]>>>; auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ auth_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ basic_auth_location: ZodDefault<ZodString>; basic_auth_header: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<ZodNumber>; oauth2_headers: ZodOptional<ZodRecord<..., ...>>; oauth2_body_params: ZodOptional<ZodRecord<..., ...>>; oauth2_token_response_key: ZodDefault<ZodString>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>]>>>; network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ZodString; value: ZodOptional<ZodNullable<...>>; type: ZodEnum<[..., ...]>; } & { is_redacted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; target_metadata: ZodOptional<ZodObject<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>; target_background: ZodOptional<ZodNullable<ZodObject<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; profiling_status: ZodOptional<ZodNullable<ZodString>>; additional_context: ZodOptional<ZodNullable<ZodObject<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The target response after probing.

Example

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

const target = await rt.targets.probe({
  name: 'prod-chatbot',
  uuid: '550e8400-e29b-41d4-a716-446655440000',
  probe_fields: ['multi_turn', 'rate_limit'],
});
// target =>
// { uuid: '550e8400-...', name: 'prod-chatbot', status: 'READY', validated: true }

---

getProfile()

getProfile(uuid): Promise<objectOutputType<{
  other_details_prettified: ZodOptional<ZodUnion<[ZodObject<{
     execution_environment: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     core_architecture_and_identity: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     tools_and_integrations: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     audience_and_governance: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     performance_and_metrics: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     content_policy: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
     other_discoveries: ZodOptional<ZodObject<{
     }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     execution_environment: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     core_architecture_and_identity: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     tools_and_integrations: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     audience_and_governance: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     performance_and_metrics: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     content_policy: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     other_discoveries: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     execution_environment: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     core_architecture_and_identity: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     tools_and_integrations: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     audience_and_governance: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     performance_and_metrics: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     content_policy: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
     other_discoveries: ZodOptional<ZodObject<..., ..., ..., ..., ...>>;
  }, ZodTypeAny, "passthrough">>, ZodNull]>>;
  ai_generated_items: ZodOptional<ZodUnion<[ZodObject<{
     languages_supported: ZodOptional<ZodUnion<[..., ...]>>;
     tools_accessible: ZodOptional<ZodUnion<[..., ...]>>;
     banned_keywords: ZodOptional<ZodUnion<[..., ...]>>;
     competitors: ZodOptional<ZodUnion<[..., ...]>>;
     base_model: ZodOptional<ZodUnion<[..., ...]>>;
     core_architecture: ZodOptional<ZodUnion<[..., ...]>>;
     system_prompt: ZodOptional<ZodUnion<[..., ...]>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     languages_supported: ZodOptional<ZodUnion<...>>;
     tools_accessible: ZodOptional<ZodUnion<...>>;
     banned_keywords: ZodOptional<ZodUnion<...>>;
     competitors: ZodOptional<ZodUnion<...>>;
     base_model: ZodOptional<ZodUnion<...>>;
     core_architecture: ZodOptional<ZodUnion<...>>;
     system_prompt: ZodOptional<ZodUnion<...>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     languages_supported: ZodOptional<ZodUnion<...>>;
     tools_accessible: ZodOptional<ZodUnion<...>>;
     banned_keywords: ZodOptional<ZodUnion<...>>;
     competitors: ZodOptional<ZodUnion<...>>;
     base_model: ZodOptional<ZodUnion<...>>;
     core_architecture: ZodOptional<ZodUnion<...>>;
     system_prompt: ZodOptional<ZodUnion<...>>;
  }, ZodTypeAny, "passthrough">>, ZodNull]>>;
  profiling_completed_at: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
  target_id: ZodString;
  target_version: ZodNumber;
  status: ZodString;
  profiling_status: ZodOptional<ZodNullable<ZodString>>;
  target_background: ZodOptional<ZodNullable<ZodObject<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  additional_context: ZodOptional<ZodNullable<ZodObject<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  ai_generated_fields: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
  other_details: ZodOptional<ZodNullable<ZodObject<{
     items: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     items: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     items: ZodOptional<ZodRecord<ZodString, ZodUnknown>>;
  }, ZodTypeAny, "passthrough">>>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:386

Get profiling results for a target.

Parameters

Parameter	Type	Description
uuid	string	The target UUID.

Returns

Promise<objectOutputType<{ other_details_prettified: ZodOptional<ZodUnion<[ZodObject<{ execution_environment: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; core_architecture_and_identity: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; tools_and_integrations: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; audience_and_governance: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; performance_and_metrics: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; content_policy: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; other_discoveries: ZodOptional<ZodObject<{ }, "passthrough", ZodTypeAny, objectOutputType<..., ..., ...>, objectInputType<..., ..., ...>>>; }, "passthrough", ZodTypeAny, objectOutputType<{ execution_environment: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; core_architecture_and_identity: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; tools_and_integrations: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; audience_and_governance: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; performance_and_metrics: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; content_policy: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; other_discoveries: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ execution_environment: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; core_architecture_and_identity: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; tools_and_integrations: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; audience_and_governance: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; performance_and_metrics: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; content_policy: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; other_discoveries: ZodOptional<ZodObject<..., ..., ..., ..., ...>>; }, ZodTypeAny, "passthrough">>, ZodNull]>>; ai_generated_items: ZodOptional<ZodUnion<[ZodObject<{ languages_supported: ZodOptional<ZodUnion<[..., ...]>>; tools_accessible: ZodOptional<ZodUnion<[..., ...]>>; banned_keywords: ZodOptional<ZodUnion<[..., ...]>>; competitors: ZodOptional<ZodUnion<[..., ...]>>; base_model: ZodOptional<ZodUnion<[..., ...]>>; core_architecture: ZodOptional<ZodUnion<[..., ...]>>; system_prompt: ZodOptional<ZodUnion<[..., ...]>>; }, "passthrough", ZodTypeAny, objectOutputType<{ languages_supported: ZodOptional<ZodUnion<...>>; tools_accessible: ZodOptional<ZodUnion<...>>; banned_keywords: ZodOptional<ZodUnion<...>>; competitors: ZodOptional<ZodUnion<...>>; base_model: ZodOptional<ZodUnion<...>>; core_architecture: ZodOptional<ZodUnion<...>>; system_prompt: ZodOptional<ZodUnion<...>>; }, ZodTypeAny, "passthrough">, objectInputType<{ languages_supported: ZodOptional<ZodUnion<...>>; tools_accessible: ZodOptional<ZodUnion<...>>; banned_keywords: ZodOptional<ZodUnion<...>>; competitors: ZodOptional<ZodUnion<...>>; base_model: ZodOptional<ZodUnion<...>>; core_architecture: ZodOptional<ZodUnion<...>>; system_prompt: ZodOptional<ZodUnion<...>>; }, ZodTypeAny, "passthrough">>, ZodNull]>>; profiling_completed_at: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>; target_id: ZodString; target_version: ZodNumber; status: ZodString; profiling_status: ZodOptional<ZodNullable<ZodString>>; target_background: ZodOptional<ZodNullable<ZodObject<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; additional_context: ZodOptional<ZodNullable<ZodObject<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; ai_generated_fields: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; other_details: ZodOptional<ZodNullable<ZodObject<{ items: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; }, "passthrough", ZodTypeAny, objectOutputType<{ items: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; }, ZodTypeAny, "passthrough">, objectInputType<{ items: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; }, ZodTypeAny, "passthrough">>>>; }, ZodTypeAny, "passthrough">>

The target profile response.

Example

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

const profile = await rt.targets.getProfile('550e8400-e29b-41d4-a716-446655440000');
// profile =>
// { target_id: '550e8400-...', target_version: 1, status: 'READY' }

---

updateProfile()

updateProfile(uuid, body): Promise<objectOutputType<{
  adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>;
  connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     ws_response_timeout: ZodDefault<...>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     ws_response_timeout: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   } & {
     response_stop_key: ZodString;
     response_stop_value: ZodString;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ...;
     api_endpoint: ...;
     request_headers: ...;
     request_json: ...;
     response_json: ...;
     response_key: ...;
     target_connection_config: ...;
     curl: ...;
     multi_turn_config: ...;
   } & {
     response_stop_key: ...;
     response_stop_value: ...;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     multi_turn_supported: ZodOptional<ZodBoolean>;
     api_endpoint: ZodOptional<ZodNullable<...>>;
     request_headers: ZodOptional<ZodNullable<...>>;
     request_json: ZodOptional<ZodNullable<...>>;
     response_json: ZodOptional<ZodNullable<...>>;
     response_key: ZodOptional<ZodNullable<...>>;
     target_connection_config: ZodOptional<ZodNullable<...>>;
     curl: ZodOptional<ZodNullable<...>>;
     multi_turn_config: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     multi_turn_supported: ZodOptional<...>;
     api_endpoint: ZodOptional<...>;
     request_headers: ZodOptional<...>;
     request_json: ZodOptional<...>;
     response_json: ZodOptional<...>;
     response_key: ZodOptional<...>;
     target_connection_config: ZodOptional<...>;
     curl: ZodOptional<...>;
     multi_turn_config: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{
     auth_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     auth_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     basic_auth_location: ZodDefault<ZodString>;
     basic_auth_header: ZodOptional<ZodNullable<...>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     basic_auth_location: ZodDefault<...>;
     basic_auth_header: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">>, ZodObject<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<ZodNumber>;
     oauth2_headers: ZodOptional<ZodRecord<..., ...>>;
     oauth2_body_params: ZodOptional<ZodRecord<..., ...>>;
     oauth2_token_response_key: ZodDefault<ZodString>;
     oauth2_inject_header: ZodRecord<ZodString, ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     oauth2_token_url: ZodString;
     oauth2_expiry_minutes: ZodDefault<...>;
     oauth2_headers: ZodOptional<...>;
     oauth2_body_params: ZodOptional<...>;
     oauth2_token_response_key: ZodDefault<...>;
     oauth2_inject_header: ZodRecord<..., ...>;
  }, ZodTypeAny, "passthrough">>]>>>;
  network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
  adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{
     key: ZodString;
     value: ZodOptional<ZodNullable<...>>;
     type: ZodEnum<[..., ...]>;
   } & {
     is_redacted: ZodOptional<ZodBoolean>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     key: ZodString;
     value: ZodOptional<...>;
     type: ZodEnum<...>;
   } & {
     is_redacted: ZodOptional<...>;
  }, ZodTypeAny, "passthrough">>, "many">>>;
  uuid: ZodString;
  tsg_id: ZodString;
  name: ZodString;
  status: ZodString;
  active: ZodBoolean;
  validated: ZodBoolean;
  created_at: ZodString;
  updated_at: ZodString;
  description: ZodOptional<ZodNullable<ZodString>>;
  target_type: ZodOptional<ZodNullable<ZodString>>;
  connection_type: ZodOptional<ZodNullable<ZodString>>;
  api_endpoint_type: ZodOptional<ZodNullable<ZodString>>;
  response_mode: ZodOptional<ZodNullable<ZodString>>;
  session_supported: ZodOptional<ZodBoolean>;
  extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
  version: ZodOptional<ZodNullable<ZodNumber>>;
  secret_version: ZodOptional<ZodNullable<ZodString>>;
  created_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  updated_by_user_id: ZodOptional<ZodNullable<ZodString>>;
  target_metadata: ZodOptional<ZodObject<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     supports_multimodal_files: ZodOptional<ZodBoolean>;
     supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>;
     multi_turn: ZodOptional<ZodBoolean>;
     multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>;
     rate_limit: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_enabled: ZodOptional<ZodBoolean>;
     rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>;
     content_filter_enabled: ZodOptional<ZodBoolean>;
     content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>;
     content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>;
     content_filter_error_message: ZodOptional<ZodNullable<ZodString>>;
     probe_message: ZodOptional<ZodString>;
     request_timeout: ZodOptional<ZodNumber>;
  }, ZodTypeAny, "passthrough">>>;
  target_background: ZodOptional<ZodNullable<ZodObject<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     agentic_profiling_enabled: ZodOptional<ZodBoolean>;
     industry: ZodOptional<ZodNullable<ZodString>>;
     use_case: ZodOptional<ZodNullable<ZodString>>;
     competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  profiling_status: ZodOptional<ZodNullable<ZodString>>;
  additional_context: ZodOptional<ZodNullable<ZodObject<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     base_model: ZodOptional<ZodNullable<ZodString>>;
     core_architecture: ZodOptional<ZodNullable<ZodString>>;
     system_prompt: ZodOptional<ZodNullable<ZodString>>;
     languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
     tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>;
  }, ZodTypeAny, "passthrough">>>>;
  auth_type: ZodOptional<ZodNullable<ZodString>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:416

Update a target profile (background + additional context).

Parameters

Parameter	Type	Description
uuid	string	The target UUID.
body	objectOutputType	The context update request body.

Returns

Promise<objectOutputType<{ adapter_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; canonical_id: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_secret_version: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; profiling_progress: ZodOptional<ZodUnion<[ZodNumber, ZodNull]>>; connection_params: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { ws_response_timeout: ZodDefault<...>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { ws_response_timeout: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; } & { response_stop_key: ZodString; response_stop_value: ZodString; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ...; api_endpoint: ...; request_headers: ...; request_json: ...; response_json: ...; response_key: ...; target_connection_config: ...; curl: ...; multi_turn_config: ...; } & { response_stop_key: ...; response_stop_value: ...; }, ZodTypeAny, "passthrough">>, ZodObject<{ multi_turn_supported: ZodOptional<ZodBoolean>; api_endpoint: ZodOptional<ZodNullable<...>>; request_headers: ZodOptional<ZodNullable<...>>; request_json: ZodOptional<ZodNullable<...>>; response_json: ZodOptional<ZodNullable<...>>; response_key: ZodOptional<ZodNullable<...>>; target_connection_config: ZodOptional<ZodNullable<...>>; curl: ZodOptional<ZodNullable<...>>; multi_turn_config: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ multi_turn_supported: ZodOptional<...>; api_endpoint: ZodOptional<...>; request_headers: ZodOptional<...>; request_json: ZodOptional<...>; response_json: ZodOptional<...>; response_key: ZodOptional<...>; target_connection_config: ZodOptional<...>; curl: ZodOptional<...>; multi_turn_config: ZodOptional<...>; }, ZodTypeAny, "passthrough">>]>>>; auth_config: ZodOptional<ZodNullable<ZodUnion<[ZodObject<{ auth_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ auth_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ basic_auth_location: ZodDefault<ZodString>; basic_auth_header: ZodOptional<ZodNullable<...>>; }, "passthrough", ZodTypeAny, objectOutputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ basic_auth_location: ZodDefault<...>; basic_auth_header: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, ZodObject<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<ZodNumber>; oauth2_headers: ZodOptional<ZodRecord<..., ...>>; oauth2_body_params: ZodOptional<ZodRecord<..., ...>>; oauth2_token_response_key: ZodDefault<ZodString>; oauth2_inject_header: ZodRecord<ZodString, ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">, objectInputType<{ oauth2_token_url: ZodString; oauth2_expiry_minutes: ZodDefault<...>; oauth2_headers: ZodOptional<...>; oauth2_body_params: ZodOptional<...>; oauth2_token_response_key: ZodDefault<...>; oauth2_inject_header: ZodRecord<..., ...>; }, ZodTypeAny, "passthrough">>]>>>; network_broker_channel_uuid: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; adapter_variable_overrides: ZodOptional<ZodNullable<ZodArray<ZodObject<{ key: ZodString; value: ZodOptional<ZodNullable<...>>; type: ZodEnum<[..., ...]>; } & { is_redacted: ZodOptional<ZodBoolean>; }, "passthrough", ZodTypeAny, objectOutputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">, objectInputType<{ key: ZodString; value: ZodOptional<...>; type: ZodEnum<...>; } & { is_redacted: ZodOptional<...>; }, ZodTypeAny, "passthrough">>, "many">>>; uuid: ZodString; tsg_id: ZodString; name: ZodString; status: ZodString; active: ZodBoolean; validated: ZodBoolean; created_at: ZodString; updated_at: ZodString; description: ZodOptional<ZodNullable<ZodString>>; target_type: ZodOptional<ZodNullable<ZodString>>; connection_type: ZodOptional<ZodNullable<ZodString>>; api_endpoint_type: ZodOptional<ZodNullable<ZodString>>; response_mode: ZodOptional<ZodNullable<ZodString>>; session_supported: ZodOptional<ZodBoolean>; extra_info: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; version: ZodOptional<ZodNullable<ZodNumber>>; secret_version: ZodOptional<ZodNullable<ZodString>>; created_by_user_id: ZodOptional<ZodNullable<ZodString>>; updated_by_user_id: ZodOptional<ZodNullable<ZodString>>; target_metadata: ZodOptional<ZodObject<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, "passthrough", ZodTypeAny, objectOutputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">, objectInputType<{ supports_multimodal_files: ZodOptional<ZodBoolean>; supports_multimodal_files_error_message: ZodOptional<ZodUnion<[ZodString, ZodNull]>>; multi_turn: ZodOptional<ZodBoolean>; multi_turn_error_message: ZodOptional<ZodNullable<ZodString>>; rate_limit: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_enabled: ZodOptional<ZodBoolean>; rate_limit_error_code: ZodOptional<ZodNullable<ZodNumber>>; rate_limit_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; rate_limit_error_message: ZodOptional<ZodNullable<ZodString>>; content_filter_enabled: ZodOptional<ZodBoolean>; content_filter_error_code: ZodOptional<ZodNullable<ZodNumber>>; content_filter_error_json: ZodOptional<ZodNullable<ZodRecord<ZodString, ZodUnknown>>>; content_filter_error_message: ZodOptional<ZodNullable<ZodString>>; probe_message: ZodOptional<ZodString>; request_timeout: ZodOptional<ZodNumber>; }, ZodTypeAny, "passthrough">>>; target_background: ZodOptional<ZodNullable<ZodObject<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ agentic_profiling_enabled: ZodOptional<ZodBoolean>; industry: ZodOptional<ZodNullable<ZodString>>; use_case: ZodOptional<ZodNullable<ZodString>>; competitors: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; profiling_status: ZodOptional<ZodNullable<ZodString>>; additional_context: ZodOptional<ZodNullable<ZodObject<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<ZodString, "many">>>; }, "passthrough", ZodTypeAny, objectOutputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">, objectInputType<{ base_model: ZodOptional<ZodNullable<ZodString>>; core_architecture: ZodOptional<ZodNullable<ZodString>>; system_prompt: ZodOptional<ZodNullable<ZodString>>; languages_supported: ZodOptional<ZodNullable<ZodArray<..., ...>>>; banned_keywords: ZodOptional<ZodNullable<ZodArray<..., ...>>>; tools_accessible: ZodOptional<ZodNullable<ZodArray<..., ...>>>; }, ZodTypeAny, "passthrough">>>>; auth_type: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>

The updated target response.

Example

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

const target = await rt.targets.updateProfile('550e8400-e29b-41d4-a716-446655440000', {
  target_background: { industry: 'Healthcare', use_case: 'Patient Support Chatbot' },
  additional_context: { base_model: 'GPT-4', languages_supported: ['en', 'es'] },
});
// target =>
// { uuid: '550e8400-...', name: 'prod-chatbot', status: 'READY' }

---

validateAuth()

validateAuth(body): Promise<objectOutputType<{
  validated: ZodBoolean;
  token_preview: ZodOptional<ZodNullable<ZodString>>;
  expires_in: ZodOptional<ZodNullable<ZodNumber>>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:447

Validate target authentication credentials.

Parameters

Parameter	Type	Description
body	objectOutputType	The auth validation request body.

Returns

Promise<objectOutputType<{ validated: ZodBoolean; token_preview: ZodOptional<ZodNullable<ZodString>>; expires_in: ZodOptional<ZodNullable<ZodNumber>>; }, ZodTypeAny, "passthrough">>

The auth validation response.

Example

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

const result = await rt.targets.validateAuth({
  auth_type: 'HEADERS',
  auth_config: { Authorization: 'Bearer sk-xxx' },
});
// result =>
// { validated: true }

---

getTargetMetadata()

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

Defined in: src/red-team/targets-client.ts:473

Get target metadata (field definitions for target configuration).

Returns

Promise<Record<string, unknown>>

The target metadata object.

Example

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

const metadata = await rt.targets.getTargetMetadata();
// metadata =>
// { rate_limit: { type: 'number', required: false }, multi_turn: { type: 'boolean' } }

---

getTargetTemplates()

getTargetTemplates(): Promise<objectOutputType<{
  OPENAI: ZodRecord<ZodString, ZodUnknown>;
  HUGGING_FACE: ZodRecord<ZodString, ZodUnknown>;
  DATABRICKS: ZodRecord<ZodString, ZodUnknown>;
  BEDROCK: ZodRecord<ZodString, ZodUnknown>;
  REST: ZodRecord<ZodString, ZodUnknown>;
  STREAMING: ZodRecord<ZodString, ZodUnknown>;
  WEBSOCKET: ZodRecord<ZodString, ZodUnknown>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/red-team/targets-client.ts:497

Get target templates for all supported provider types.

Returns

Promise<objectOutputType<{ OPENAI: ZodRecord<ZodString, ZodUnknown>; HUGGING_FACE: ZodRecord<ZodString, ZodUnknown>; DATABRICKS: ZodRecord<ZodString, ZodUnknown>; BEDROCK: ZodRecord<ZodString, ZodUnknown>; REST: ZodRecord<ZodString, ZodUnknown>; STREAMING: ZodRecord<ZodString, ZodUnknown>; WEBSOCKET: ZodRecord<ZodString, ZodUnknown>; }, ZodTypeAny, "passthrough">>

The collection of target templates keyed by provider.

Example

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

const templates = await rt.targets.getTargetTemplates();
// templates =>
// { OPENAI: {...}, HUGGING_FACE: {...}, DATABRICKS: {...}, BEDROCK: {...}, REST: {...}, STREAMING: {...} }