Skip to content

StartPentestJobInput

Source code in docs_src/capo_securityagent/types/start_pentest_job_input.py
class StartPentestJobInput(TypedDict, closed=True):
    agent_space_id: "str"
    """<p>The unique identifier of the agent space.</p>"""
    pentest_id: "str"
    """<p>The unique identifier of the pentest to start a job for.</p>"""
    job_type: NotRequired["capo_securityagent.types.job_type.JobType"]
    """<p>The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.</p>"""
    selected_finding_ids: NotRequired["capo_securityagent.types.string_list.StringList"]
    """<p>The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.</p>"""
    scope_changes: NotRequired[
        "capo_securityagent.types.scope_change_list.ScopeChangeList"
    ]
    """<p>The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.</p>"""

agent_space_id instance-attribute

agent_space_id: str

The unique identifier of the agent space.

job_type instance-attribute

job_type: NotRequired[JobType]

The type of pentest job to start. Valid values are FULL, REVALIDATION, and CICD. When set to REVALIDATION, the selectedFindingIds parameter is required. When set to CICD, the scopeChanges parameter defines the code changes to test.

pentest_id instance-attribute

pentest_id: str

The unique identifier of the pentest to start a job for.

scope_changes instance-attribute

scope_changes: NotRequired[ScopeChangeList]

The code changes that define the scope of a CI/CD pentest job. Provide this when starting a job with jobType CICD to test only the changes in the current pipeline run.

selected_finding_ids instance-attribute

selected_finding_ids: NotRequired[StringList]

The list of finding identifiers to revalidate. Required when jobType is REVALIDATION. Each finding must belong to the same agent space and pentest.