---
title: "POST /UpdatePentest"
method: POST
path: "/UpdatePentest"
---

# POST /UpdatePentest

`POST /UpdatePentest`

Updates an existing pentest configuration.

## Request body

- object
  - `pentestId` string, required — The unique identifier of the pentest to update.
  - `agentSpaceId` string, required — The unique identifier of the agent space that contains the pentest.
  - `title` string — The updated title of the pentest.
  - `assets` object — The collection of assets used in a pentest configuration, including endpoints, actors, documents, source code repositories, and integrated repositories.
    - `endpoints` Endpoint[] — The list of endpoints to test during the pentest.
      - `uri` string — The URI of the endpoint.
    - `actors` Actor[] — The list of actors used during penetration testing.
      - `identifier` string — The unique identifier for the actor.
      - `uris` String[] — The list of URIs that the actor targets during testing.
      - `authentication` object — The authentication configuration for the actor.
        - `providerType` 'SECRETS_MANAGER' | 'AWS_LAMBDA' | 'AWS_IAM_ROLE' | 'AWS_INTERNAL' — The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.
        - `value` string — The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.
      - `description` string — A description of the actor.
    - `documents` DocumentInfo[] — The list of documents that provide context for the pentest.
      - `s3Location` string — The Amazon S3 location of the document.
      - `artifactId` string — The unique identifier of the artifact associated with the document.
      - `integratedDocument` object — A reference to a document in an integrated third-party provider.
        - `integrationId` string, required — The identifier of the integration that provides access to the document.
        - `resourceId` string, required — The provider-specific resource identifier for the document.
    - `sourceCode` SourceCodeRepository[] — The list of source code repositories to analyze during the pentest.
      - `s3Location` string — The Amazon S3 location of the source code repository archive.
    - `integratedRepositories` IntegratedRepository[] — The list of integrated repositories associated with the pentest.
      - `integrationId` string, required — The unique identifier of the integration that provides access to the repository.
      - `providerResourceId` string, required — The provider-specific resource identifier for the repository.
  - `excludeRiskTypes` RiskType[] — The updated list of risk types to exclude from the pentest.
  - `serviceRole` string — ARN of an IAM role that the service can assume to access customer resources.
  - `logConfig` object — The Amazon CloudWatch Logs configuration for pentest job logging.
    - `logGroup` string — The name of the CloudWatch log group.
    - `logStream` string — The name of the CloudWatch log stream.
  - `vpcConfig` object — The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.
    - `vpcArn` string — The Amazon Resource Name (ARN) of the VPC.
    - `securityGroupArns` SecurityGroupArn[] — The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.
    - `subnetArns` SubnetArn[] — The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.
  - `networkTrafficConfig` object — The network traffic configuration for a pentest, including custom headers and traffic rules.
    - `rules` NetworkTrafficRule[] — The list of network traffic rules that control which URLs are allowed or denied during testing.
      - `effect` 'ALLOW' | 'DENY' — The effect of the rule. Valid values are ALLOW and DENY.
      - `pattern` string — The URL pattern to match for the rule.
      - `networkTrafficRuleType` 'URL' — The type of the network traffic rule. Currently, only URL is supported.
    - `customHeaders` CustomHeader[] — The list of custom HTTP headers to include in network traffic during testing.
      - `name` string — The name of the custom header.
      - `value` string — The value of the custom header.
  - `codeRemediationStrategy` 'AUTOMATIC' | 'DISABLED' — Strategy for automated code remediation.
  - `disableManagedSkills` SkillType[] — A list of skill types.

## Response `200`

Success

- UpdatePentestOutput — Output for the UpdatePentest operation.
  - `pentestId` string — The unique identifier of the pentest.
  - `title` string — The title of the pentest.
  - `createdAt` string, date-time — The date and time the pentest was created, in UTC format.
  - `updatedAt` string, date-time — The date and time the pentest was last updated, in UTC format.
  - `assets` object — The assets included in the pentest.
    - `endpoints` Endpoint[] — The list of endpoints to test during the pentest.
      - `uri` string — The URI of the endpoint.
    - `actors` Actor[] — The list of actors used during penetration testing.
      - `identifier` string — The unique identifier for the actor.
      - `uris` String[] — The list of URIs that the actor targets during testing.
      - `authentication` object — The authentication configuration for the actor.
        - `providerType` 'SECRETS_MANAGER' | 'AWS_LAMBDA' | 'AWS_IAM_ROLE' | 'AWS_INTERNAL' — The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.
        - `value` string — The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.
      - `description` string — A description of the actor.
    - `documents` DocumentInfo[] — The list of documents that provide context for the pentest.
      - `s3Location` string — The Amazon S3 location of the document.
      - `artifactId` string — The unique identifier of the artifact associated with the document.
      - `integratedDocument` object — A reference to a document in an integrated third-party provider.
        - `integrationId` string, required — The identifier of the integration that provides access to the document.
        - `resourceId` string, required — The provider-specific resource identifier for the document.
    - `sourceCode` SourceCodeRepository[] — The list of source code repositories to analyze during the pentest.
      - `s3Location` string — The Amazon S3 location of the source code repository archive.
    - `integratedRepositories` IntegratedRepository[] — The list of integrated repositories associated with the pentest.
      - `integrationId` string, required — The unique identifier of the integration that provides access to the repository.
      - `providerResourceId` string, required — The provider-specific resource identifier for the repository.
  - `excludeRiskTypes` RiskType[] — The list of risk types excluded from the pentest.
  - `serviceRole` string — The IAM service role used for the pentest.
  - `logConfig` object — The CloudWatch Logs configuration for the pentest.
    - `logGroup` string — The name of the CloudWatch log group.
    - `logStream` string — The name of the CloudWatch log stream.
  - `agentSpaceId` string — The unique identifier of the agent space that contains the pentest.

---

[API](https://skmtc.net/aws/apis/securityagent.md) · [All operations](https://skmtc.net/aws/apis/securityagent/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/securityagent/versions/cad56717d636/schema)