--- title: "POST /BatchGetPentestJobs" method: POST path: "/BatchGetPentestJobs" --- # POST /BatchGetPentestJobs `POST /BatchGetPentestJobs` Retrieves information about one or more pentest jobs in an agent space. ## Request body - object - `pentestJobIds` String[], required — The list of pentest job identifiers to retrieve. - `agentSpaceId` string, required — The unique identifier of the agent space that contains the pentest jobs. ## Response `200` Success - BatchGetPentestJobsOutput — Output for the BatchGetPentestJobs operation. - `pentestJobs` PentestJob[] — The list of pentest jobs that were found. - `pentestJobId` string — The unique identifier of the pentest job. - `pentestId` string — The unique identifier of the pentest associated with the job. - `title` string — The title of the pentest job. - `overview` string — An overview of the pentest job results. - `status` 'IN_PROGRESS' | 'STOPPING' | 'STOPPED' | 'FAILED' | 'COMPLETED' — The current status of the pentest job. - `endpoints` Endpoint[] — The list of endpoints being tested in the pentest job. - `uri` string — The URI of the endpoint. - `actors` Actor[] — The list of actors used during the pentest job. - `identifier` string — The unique identifier for the actor. - `uris` String[] — The list of URIs that the actor targets during testing. - `authentication` object — The authentication configuration for the actor. - `providerType` 'SECRETS_MANAGER' | 'AWS_LAMBDA' | 'AWS_IAM_ROLE' | 'AWS_INTERNAL' — The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL. - `value` string — The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type. - `description` string — A description of the actor. - `documents` DocumentInfo[] — The list of documents providing context for the pentest job. - `s3Location` string — The Amazon S3 location of the document. - `artifactId` string — The unique identifier of the artifact associated with the document. - `integratedDocument` object — A reference to a document in an integrated third-party provider. - `integrationId` string, required — The identifier of the integration that provides access to the document. - `resourceId` string, required — The provider-specific resource identifier for the document. - `sourceCode` SourceCodeRepository[] — The list of source code repositories analyzed during the pentest job. - `s3Location` string — The Amazon S3 location of the source code repository archive. - `excludePaths` Endpoint[] — The list of paths excluded from the pentest job. - `uri` string — The URI of the endpoint. - `allowedDomains` Endpoint[] — The list of domains allowed during the pentest job. - `uri` string — The URI of the endpoint. - `excludeRiskTypes` RiskType[] — The list of risk types excluded from the pentest job. - `steps` Step[] — The list of steps in the pentest job execution. - `name` 'PREFLIGHT' | 'STATIC_ANALYSIS' | 'PENTEST' | 'FINALIZING' | 'VALIDATION' — The name of the step. Valid values include PREFLIGHT, STATIC_ANALYSIS, PENTEST, VALIDATION, and FINALIZING. - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'STOPPED' — The current status of the step. - `createdAt` string, date-time — The date and time the step was created, in UTC format. - `updatedAt` string, date-time — The date and time the step was last updated, in UTC format. - `executionContext` ExecutionContext[] — The execution context messages for the pentest job. - `contextType` 'ERROR' | 'CLIENT_ERROR' | 'WARNING' | 'INFO' — The type of context. Valid values include ERROR, CLIENT_ERROR, WARNING, and INFO. - `context` string — The context message. - `timestamp` string, date-time — The date and time the context was recorded, in UTC format. - `serviceRole` string — The IAM service role used for the pentest job. - `logConfig` object — The CloudWatch Logs configuration for the pentest job. - `logGroup` string — The name of the CloudWatch log group. - `logStream` string — The name of the CloudWatch log stream. - `vpcConfig` object — The VPC configuration for the pentest job. - `vpcArn` string — The Amazon Resource Name (ARN) of the VPC. - `securityGroupArns` SecurityGroupArn[] — The Amazon Resource Names (ARNs) of the security groups for the VPC configuration. - `subnetArns` SubnetArn[] — The Amazon Resource Names (ARNs) of the subnets for the VPC configuration. - `networkTrafficConfig` object — The network traffic configuration for the pentest job. - `rules` NetworkTrafficRule[] — The list of network traffic rules that control which URLs are allowed or denied during testing. - `effect` 'ALLOW' | 'DENY' — The effect of the rule. Valid values are ALLOW and DENY. - `pattern` string — The URL pattern to match for the rule. - `networkTrafficRuleType` 'URL' — The type of the network traffic rule. Currently, only URL is supported. - `customHeaders` CustomHeader[] — The list of custom HTTP headers to include in network traffic during testing. - `name` string — The name of the custom header. - `value` string — The value of the custom header. - `errorInformation` object — Error information if the pentest job encountered an error. - `code` 'CLIENT_ERROR' | 'INTERNAL_ERROR' | 'STOPPED_BY_USER' — The error code. Valid values include CLIENT_ERROR, INTERNAL_ERROR, and STOPPED_BY_USER. - `message` string — A message describing the error. - `integratedRepositories` IntegratedRepository[] — The list of integrated repositories associated with the pentest job. - `integrationId` string, required — The unique identifier of the integration that provides access to the repository. - `providerResourceId` string, required — The provider-specific resource identifier for the repository. - `codeRemediationStrategy` 'AUTOMATIC' | 'DISABLED' — The code remediation strategy for the pentest job. - `cleanUpStrategy` 'BEST_EFFORT_DELETE' | 'RETAIN_ALL' — Strategy for cleaning up resources after pentest job completion. - `disableManagedSkills` SkillType[] — A list of managed skills disabled for this pentest job. Valid values include FINDING_PERSONALIZATION and LOGIN_OPTIMIZATION. - `createdAt` string, date-time — The date and time the pentest job was created, in UTC format. - `updatedAt` string, date-time — The date and time the pentest job was last updated, in UTC format. - `notFound` String[] — The list of pentest job identifiers that were not found. --- [API](https://skmtc.net/aws/apis/securityagent.md) · [All operations](https://skmtc.net/aws/apis/securityagent/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/securityagent/versions/cad56717d636/schema)