Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreatePentest

Creates a new pentest configuration in an agent space. A pentest defines the security test parameters, including target assets, risk type exclusions, and logging configuration.

Request Syntax


POST /CreatePentest HTTP/1.1
Content-type: application/json

{
   "agentSpaceId": "string",
   "assets": { 
      "actors": [ 
         { 
            "authentication": { 
               "providerType": "string",
               "value": "string"
            },
            "description": "string",
            "identifier": "string",
            "uris": [ "string" ]
         }
      ],
      "documents": [ 
         { 
            "artifactId": "string",
            "s3Location": "string"
         }
      ],
      "endpoints": [ 
         { 
            "uri": "string"
         }
      ],
      "integratedRepositories": [ 
         { 
            "integrationId": "string",
            "providerResourceId": "string"
         }
      ],
      "sourceCode": [ 
         { 
            "s3Location": "string"
         }
      ]
   },
   "codeRemediationStrategy": "string",
   "excludeRiskTypes": [ "string" ],
   "logConfig": { 
      "logGroup": "string",
      "logStream": "string"
   },
   "networkTrafficConfig": { 
      "customHeaders": [ 
         { 
            "name": "string",
            "value": "string"
         }
      ],
      "rules": [ 
         { 
            "effect": "string",
            "networkTrafficRuleType": "string",
            "pattern": "string"
         }
      ]
   },
   "serviceRole": "string",
   "title": "string",
   "vpcConfig": { 
      "securityGroupArns": [ "string" ],
      "subnetArns": [ "string" ],
      "vpcArn": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

agentSpaceId

The unique identifier of the agent space to create the pentest in.

Type: String

Required: Yes

assets

The assets to include in the pentest, such as endpoints, actors, documents, and source code.

Type: Assets object

Required: No

codeRemediationStrategy

The code remediation strategy for the pentest. Valid values are AUTOMATIC and DISABLED.

Type: String

Valid Values: AUTOMATIC | DISABLED

Required: No

excludeRiskTypes

The list of risk types to exclude from the pentest.

Type: Array of strings

Required: No

logConfig

The CloudWatch Logs configuration for the pentest.

Type: CloudWatchLog object

Required: No

networkTrafficConfig

The network traffic configuration for the pentest, including custom headers and traffic rules.

Type: NetworkTrafficConfig object

Required: No

serviceRole

The IAM service role to use for the pentest.

Type: String

Required: No

title

The title of the pentest.

Type: String

Required: Yes

vpcConfig

The VPC configuration for the pentest.

Type: VpcConfig object

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "agentSpaceId": "string",
   "assets": { 
      "actors": [ 
         { 
            "authentication": { 
               "providerType": "string",
               "value": "string"
            },
            "description": "string",
            "identifier": "string",
            "uris": [ "string" ]
         }
      ],
      "documents": [ 
         { 
            "artifactId": "string",
            "s3Location": "string"
         }
      ],
      "endpoints": [ 
         { 
            "uri": "string"
         }
      ],
      "integratedRepositories": [ 
         { 
            "integrationId": "string",
            "providerResourceId": "string"
         }
      ],
      "sourceCode": [ 
         { 
            "s3Location": "string"
         }
      ]
   },
   "createdAt": "string",
   "excludeRiskTypes": [ "string" ],
   "logConfig": { 
      "logGroup": "string",
      "logStream": "string"
   },
   "pentestId": "string",
   "serviceRole": "string",
   "title": "string",
   "updatedAt": "string"
}