Skip to content

Task

Source code in docs_src/capo_securityagent/types/task.py
class Task(TypedDict, closed=True):
    task_id: "str"
    """<p>The unique identifier of the task.</p>"""
    pentest_id: NotRequired["str"]
    """<p>The unique identifier of the pentest associated with the task.</p>"""
    pentest_job_id: NotRequired["str"]
    """<p>The unique identifier of the pentest job that contains the task.</p>"""
    agent_space_id: NotRequired["str"]
    """<p>The unique identifier of the agent space.</p>"""
    title: NotRequired["str"]
    """<p>The title of the task.</p>"""
    description: NotRequired["str"]
    """<p>A description of the task.</p>"""
    categories: NotRequired["capo_securityagent.types.category_list.CategoryList"]
    """<p>The list of categories assigned to the task.</p>"""
    risk_type: NotRequired["capo_securityagent.types.risk_type.RiskType"]
    """<p>The type of security risk the task is testing for.</p>"""
    target_endpoint: NotRequired["capo_securityagent.types.endpoint.Endpoint"]
    """<p>The target endpoint being tested by the task.</p>"""
    execution_status: NotRequired[
        "capo_securityagent.types.task_execution_status.TaskExecutionStatus"
    ]
    """<p>The current execution status of the task.</p>"""
    logs_location: NotRequired["capo_securityagent.types.log_location.LogLocation"]
    """<p>The location of the task execution logs.</p>"""
    task_hours: NotRequired["float"]
    """<p>The number of active work hours consumed by the task during execution.</p>"""
    created_at: NotRequired["datetime.datetime"]
    """<p>The date and time the task was created, in UTC format.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The date and time the task was last updated, in UTC format.</p>"""

agent_space_id instance-attribute

agent_space_id: NotRequired[str]

The unique identifier of the agent space.

categories instance-attribute

categories: NotRequired[CategoryList]

The list of categories assigned to the task.

created_at instance-attribute

created_at: NotRequired[datetime]

The date and time the task was created, in UTC format.

description instance-attribute

description: NotRequired[str]

A description of the task.

execution_status instance-attribute

execution_status: NotRequired[TaskExecutionStatus]

The current execution status of the task.

logs_location instance-attribute

logs_location: NotRequired[LogLocation]

The location of the task execution logs.

pentest_id instance-attribute

pentest_id: NotRequired[str]

The unique identifier of the pentest associated with the task.

pentest_job_id instance-attribute

pentest_job_id: NotRequired[str]

The unique identifier of the pentest job that contains the task.

risk_type instance-attribute

risk_type: NotRequired[RiskType]

The type of security risk the task is testing for.

target_endpoint instance-attribute

target_endpoint: NotRequired[Endpoint]

The target endpoint being tested by the task.

task_hours instance-attribute

task_hours: NotRequired[float]

The number of active work hours consumed by the task during execution.

task_id instance-attribute

task_id: str

The unique identifier of the task.

title instance-attribute

title: NotRequired[str]

The title of the task.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The date and time the task was last updated, in UTC format.