SecurityAgent / Client / batch_get_pentest_job_tasks

batch_get_pentest_job_tasks¶

SecurityAgent.Client.batch_get_pentest_job_tasks(**kwargs)¶

Retrieves multiple tasks for a pentest job in a single request

Request Syntax

response = client.batch_get_pentest_job_tasks(
    agentSpaceId='string',
    taskIds=[
        'string',
    ]
)

Parameters:

agentSpaceId (string) –
[REQUIRED]

ID of the agent space where the pentest exists
taskIds (list) –
[REQUIRED]

List of task IDs to retrieve
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'tasks': [
        {
            'taskId': 'string',
            'pentestId': 'string',
            'pentestJobId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'description': 'string',
            'categories': [
                {
                    'name': 'string',
                    'isPrimary': True|False
                },
            ],
            'riskType': 'CROSS_SITE_SCRIPTING'|'DEFAULT_CREDENTIALS'|'INSECURE_DIRECT_OBJECT_REFERENCE'|'PRIVILEGE_ESCALATION'|'SERVER_SIDE_TEMPLATE_INJECTION'|'COMMAND_INJECTION'|'CODE_INJECTION'|'SQL_INJECTION'|'ARBITRARY_FILE_UPLOAD'|'INSECURE_DESERIALIZATION'|'LOCAL_FILE_INCLUSION'|'INFORMATION_DISCLOSURE'|'PATH_TRAVERSAL'|'SERVER_SIDE_REQUEST_FORGERY'|'JSON_WEB_TOKEN_VULNERABILITIES'|'XML_EXTERNAL_ENTITY'|'FILE_DELETION'|'OTHER'|'GRAPHQL_VULNERABILITIES'|'BUSINESS_LOGIC_VULNERABILITIES'|'CRYPTOGRAPHIC_VULNERABILITIES'|'DENIAL_OF_SERVICE'|'FILE_ACCESS'|'FILE_CREATION'|'DATABASE_MODIFICATION'|'DATABASE_ACCESS'|'OUTBOUND_SERVICE_REQUEST'|'UNKNOWN',
            'targetEndpoint': {
                'uri': 'string'
            },
            'executionStatus': 'IN_PROGRESS'|'ABORTED'|'COMPLETED'|'INTERNAL_ERROR'|'FAILED',
            'logsLocation': {
                'logType': 'CLOUDWATCH',
                'cloudWatchLog': {
                    'logGroup': 'string',
                    'logStream': 'string'
                }
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

(dict) –

Output for the BatchGetPentestJobTasks operation
- tasks (list) –
  
  List of successfully retrieved tasks
  - (dict) –
    
    Represents a task within a pentest job
    - taskId (string) –
      
      Unique identifier for the task
    - pentestId (string) –
      
      Identifier of the parent pentest
    - pentestJobId (string) –
      
      Identifier of the pentest job this task belongs to
    - agentSpaceId (string) –
      
      Identifier of the agent space this task belongs to
    - title (string) –
      
      Title or name of the task
    - description (string) –
      
      Detailed description of the task’s purpose and scope
    - categories (list) –
      
      List of categories associated with this task
      - (dict) –
        
        Represents a category classification for tasks
        
        name (string) –
        
        Name of the category
        
        isPrimary (boolean) –
        
        Whether this is the primary category for the task
    - riskType (string) –
      
      Type of security risk this task is designed to test
    - targetEndpoint (dict) –
      
      Target endpoint for this security test
      - uri (string) –
        
        URI of the endpoint to test
    - executionStatus (string) –
      
      Current status of the task execution
    - logsLocation (dict) –
      
      Location of execution logs for auditing and review
      - logType (string) –
        
        Type of log storage
      - cloudWatchLog (dict) –
        
        CloudWatch log information if logs are stored in CloudWatch
        
        logGroup (string) –
        
        Name of the CloudWatch log group
        
        logStream (string) –
        
        Name of the CloudWatch log stream
    - createdAt (datetime) –
      
      Timestamp when the task was created
    - updatedAt (datetime) –
      
      Timestamp when the task was last updated
- notFound (list) –
  
  List of task IDs that could not be found
  - (string) –