> ## Documentation Index
> Fetch the complete documentation index at: https://developers.aptranet.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Advanced Rule

> Project-scoped operation. Requires the advanced_rules add-on. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields.



## OpenAPI

````yaml /openapi-shield.json patch /shield/domains/{domain_id}/advanced-rules/{rule_id}
openapi: 3.1.0
info:
  title: Aptranet Cloud Shield API
  version: 1.0.0
  description: >-
    Public project-scoped API. Use the access key and secret together.
    Browser-only organization administration is documented separately. Request
    schemas and query parameters follow the service operation allowlist. Plan
    entitlements apply in addition to API permissions. Some analytics and action
    responses have operation-specific JSON shapes; where the implementation
    provides no stable response contract, the reference deliberately does not
    invent one.
servers:
  - url: https://api.aptranet.com
security:
  - bearerAuth: []
    apiSecret: []
paths:
  /shield/domains/{domain_id}/advanced-rules/{rule_id}:
    patch:
      tags:
        - Cloud Shield Advanced Rules
      summary: Update Advanced Rule
      description: >-
        Project-scoped operation. Requires the advanced_rules add-on. Successful
        JSON and status-only responses vary by operation. The service does not
        declare a stable response schema for this operation; do not assume a
        collection envelope or undocumented fields.
      operationId: PATCH_shield_domains_domain_id_advanced_rules_rule_id_
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: integer
            title: Domain Id
        - name: rule_id
          in: path
          required: true
          schema:
            type: integer
            title: Rule Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              title: UpdateAdvancedRule
              properties:
                name:
                  title: Name
                  anyOf:
                    - type: string
                      minLength: 1
                      maxLength: 100
                      example: Block foobar bot
                    - type: 'null'
                description:
                  title: Description
                  anyOf:
                    - type: string
                      maxLength: 100
                    - type: 'null'
                enabled:
                  title: Enabled
                  anyOf:
                    - type: boolean
                    - type: 'null'
                action:
                  anyOf:
                    - type: object
                      additionalProperties: false
                      title: CustomerRuleAction
                      properties:
                        allow:
                          type: object
                          additionalProperties: true
                          title: RuleAllowAction
                          properties: {}
                        block:
                          type: object
                          additionalProperties: false
                          title: RuleBlockAction
                          properties:
                            status_code:
                              type: integer
                              enum:
                                - 403
                                - 405
                                - 418
                                - 429
                              title: RuleBlockStatusCode
                            action_duration:
                              type: string
                              minLength: 1
                              maxLength: 10
                              example: 12h
                              title: Action Duration
                        captcha:
                          type: object
                          additionalProperties: true
                          title: RuleCaptchaAction
                          properties: {}
                        handshake:
                          type: object
                          additionalProperties: true
                          title: RuleHandshakeAction
                          properties: {}
                        monitor:
                          type: object
                          additionalProperties: true
                          title: RuleMonitorAction
                          properties: {}
                        tag:
                          type: object
                          required:
                            - tags
                          title: RuleTagAction
                          properties:
                            tags:
                              type: array
                              minItems: 1
                              maxItems: 5
                              title: Tags
                              items:
                                type: string
                    - type: 'null'
                source:
                  title: Source
                  anyOf:
                    - type: string
                      minLength: 1
                    - type: 'null'
                phase:
                  title: Phase
                  anyOf:
                    - type: string
                      enum:
                        - access
                        - header_filter
                        - body_filter
                    - type: 'null'
      responses:
        2XX:
          description: Successful response.
        default:
          description: >-
            Request rejected or service unavailable. See the error code and
            description; refresh before retrying a mutation whose result is
            uncertain.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Project API access key.
    apiSecret:
      type: apiKey
      in: header
      name: Aptranet-Secret
      description: Current secret for the access key.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.