openapi: 3.1.0
info:
  title: Amazon WAF IP Sets Web ACLs API
  description: AWS WAF is a web application firewall that helps protect web applications and APIs against common web exploits and bots. The API provides operations for managing web ACLs, rule groups, IP sets, regex pattern sets, and logging configurations.
  version: '2019-07-29'
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/waf/
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  termsOfService: https://aws.amazon.com/service-terms/
  x-logo:
    url: https://a0.awsstatic.com/libra-css/images/logos/aws_logo_smile_1200x630.png
servers:
- url: https://wafv2.{region}.amazonaws.com
  description: AWS WAF regional endpoint
  variables:
    region:
      default: us-east-1
      description: AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - eu-west-1
      - eu-west-2
      - eu-central-1
      - ap-northeast-1
      - ap-southeast-1
      - ap-southeast-2
      - ap-south-1
      - ca-central-1
security:
- aws_sig_v4: []
tags:
- name: Web ACLs
paths:
  /#CreateWebACL:
    post:
      operationId: CreateWebACL
      summary: Amazon WAF Create a Web ACL
      description: Creates a web ACL with the specified rules and default action for managing web traffic.
      tags:
      - Web ACLs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - Name
              - Scope
              - DefaultAction
              - VisibilityConfig
              properties:
                Name:
                  type: string
                  description: The name of the web ACL.
                Scope:
                  type: string
                  enum:
                  - CLOUDFRONT
                  - REGIONAL
                DefaultAction:
                  type: object
                  properties:
                    Allow:
                      type: object
                    Block:
                      type: object
                Rules:
                  type: array
                  items:
                    $ref: '#/components/schemas/Rule'
                VisibilityConfig:
                  $ref: '#/components/schemas/VisibilityConfig'
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Summary:
                    $ref: '#/components/schemas/WebACLSummary'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#GetWebACL:
    post:
      operationId: GetWebACL
      summary: Amazon WAF Get a Web ACL
      description: Retrieves the specified web ACL.
      tags:
      - Web ACLs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - Name
              - Scope
              - Id
              properties:
                Name:
                  type: string
                Scope:
                  type: string
                Id:
                  type: string
      responses:
        '200':
          description: Successful response.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /#ListWebACLs:
    post:
      operationId: ListWebACLs
      summary: Amazon WAF List Web ACLs
      description: Retrieves a list of web ACLs.
      tags:
      - Web ACLs
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              type: object
              required:
              - Scope
              properties:
                Scope:
                  type: string
                Limit:
                  type: integer
                NextMarker:
                  type: string
      responses:
        '200':
          description: Successful response.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    WebACLSummary:
      type: object
      properties:
        Name:
          type: string
        Id:
          type: string
        ARN:
          type: string
        LockToken:
          type: string
    Rule:
      type: object
      properties:
        Name:
          type: string
        Priority:
          type: integer
        Action:
          type: object
        VisibilityConfig:
          $ref: '#/components/schemas/VisibilityConfig'
      required:
      - Name
      - Priority
      - VisibilityConfig
    VisibilityConfig:
      type: object
      properties:
        SampledRequestsEnabled:
          type: boolean
        CloudWatchMetricsEnabled:
          type: boolean
        MetricName:
          type: string
      required:
      - SampledRequestsEnabled
      - CloudWatchMetricsEnabled
      - MetricName
  securitySchemes:
    aws_sig_v4:
      type: apiKey
      name: Authorization
      in: header
      description: AWS Signature Version 4 authentication.
externalDocs:
  description: AWS WAF API Reference
  url: https://docs.aws.amazon.com/waf/latest/APIReference/Welcome.html