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

ListPentests

Returns a paginated list of pentest summaries for the specified agent space.

Request Syntax


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

{
   "agentSpaceId": "string",
   "maxResults": number,
   "nextToken": "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 list pentests for.

Type: String

Required: Yes

maxResults

The maximum number of results to return in a single call.

Type: Integer

Required: No

nextToken

A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "pentestSummaries": [ 
      { 
         "agentSpaceId": "string",
         "createdAt": "string",
         "pentestId": "string",
         "title": "string",
         "updatedAt": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

Type: String

pentestSummaries

The list of pentest summaries.

Type: Array of PentestSummary objects

Errors

For information about the errors that are common to all actions, see Common Error Types.