APIs.io Engineering Platform Account Rulesets API

openapi: 3.0.0
info:
  version: "1.0.0"
  x-release: v4
  title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Account Rulesets API
  description: <fullname>Amazon API Gateway</fullname> <p>Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.</p>
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: apigateway
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: https://apigateway.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon API Gateway multi-region endpoint
- url: http://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
- url: https://apigateway.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: Account Rulesets
paths:
  /accounts/{account_id}/rulesets:
    get:
      description: Fetches all rulesets at the account level.
      operationId: listAccountRulesets
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Rulesets'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List account rulesets
      tags:
      - Account Rulesets
      x-api-token-group:
      - Account WAF Read
      - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    post:
      description: Creates a ruleset at the account level.
      operationId: createAccountRuleset
      parameters:
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_CreateRuleset'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create an account ruleset
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}:
    delete:
      description: Deletes all versions of an existing account ruleset.
      operationId: deleteAccountRuleset
      parameters:
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '204':
          $ref: '#/components/responses/rulesets_Empty'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an account ruleset
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches the latest version of an account ruleset.
      operationId: getAccountRuleset
      parameters:
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an account ruleset
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Mass URL Redirects Read
      - Magic Firewall Write
      - Magic Firewall Read
      - L4 DDoS Managed Ruleset Write
      - L4 DDoS Managed Ruleset Read
      - Transform Rules Write
      - Transform Rules Read
      - Select Configuration Write
      - Select Configuration Read
      - Account WAF Read
      - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates an account ruleset, creating a new version.
      operationId: updateAccountRuleset
      parameters:
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_UpdateRuleset'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an account ruleset
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/rules:
    post:
      description: Adds a new rule to an account ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.
      operationId: createAccountRulesetRule
      parameters:
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_Rule'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Create an account ruleset rule
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}:
    delete:
      description: Deletes an existing rule from an account ruleset.
      operationId: deleteAccountRulesetRule
      parameters:
      - in: path
        name: rule_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RuleId'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an account ruleset rule
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    patch:
      description: Updates an existing rule in an account ruleset.
      operationId: updateAccountRulesetRule
      parameters:
      - in: path
        name: rule_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RuleId'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_Rule'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an account ruleset rule
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/versions:
    get:
      description: Fetches the versions of an account ruleset.
      operationId: listAccountRulesetVersions
      parameters:
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Rulesets'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List an account ruleset's versions
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Mass URL Redirects Read
      - Magic Firewall Write
      - Magic Firewall Read
      - L4 DDoS Managed Ruleset Write
      - L4 DDoS Managed Ruleset Read
      - Transform Rules Write
      - Transform Rules Read
      - Select Configuration Write
      - Select Configuration Read
      - Account WAF Read
      - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}:
    delete:
      description: Deletes an existing version of an account ruleset.
      operationId: deleteAccountRulesetVersion
      parameters:
      - in: path
        name: ruleset_version
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '204':
          $ref: '#/components/responses/rulesets_Empty'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Delete an account ruleset version
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Magic Firewall Write
      - L4 DDoS Managed Ruleset Write
      - Transform Rules Write
      - Select Configuration Write
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    get:
      description: Fetches a specific version of an account ruleset.
      operationId: getAccountRulesetVersion
      parameters:
      - in: path
        name: ruleset_version
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an account ruleset version
      tags:
      - Account Rulesets
      x-api-token-group:
      - Mass URL Redirects Write
      - Mass URL Redirects Read
      - Magic Firewall Write
      - Magic Firewall Read
      - L4 DDoS Managed Ruleset Write
      - L4 DDoS Managed Ruleset Read
      - Transform Rules Write
      - Transform Rules Read
      - Select Configuration Write
      - Select Configuration Read
      - Account WAF Read
      - Account Rulesets Read
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}:
    get:
      description: Fetches the rules of a managed account ruleset version for a given tag.
      operationId: listAccountRulesetVersionRulesByTag
      parameters:
      - in: path
        name: rule_tag
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RuleCategory'
      - in: path
        name: ruleset_version
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - in: path
        name: ruleset_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List an account ruleset version's rules by tag
      tags:
      - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint:
    get:
      description: Fetches the latest version of the account entry point ruleset for a given phase.
      operationId: getAccountEntrypointRuleset
      parameters:
      - in: path
        name: ruleset_phase
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an account entry point ruleset
      tags:
      - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
    put:
      description: Updates an account entry point ruleset, creating a new version.
      operationId: updateAccountEntrypointRuleset
      parameters:
      - in: path
        name: ruleset_phase
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      requestBody:
        $ref: '#/components/requestBodies/rulesets_UpdateEntrypointRuleset'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Update an account entry point ruleset
      tags:
      - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions:
    get:
      description: Fetches the versions of an account entry point ruleset.
      operationId: listAccountEntrypointRulesetVersions
      parameters:
      - in: path
        name: ruleset_phase
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Rulesets'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform List an account entry point ruleset's versions
      tags:
      - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}:
    get:
      description: Fetches a specific version of an account entry point ruleset.
      operationId: getAccountEntrypointRulesetVersion
      parameters:
      - in: path
        name: ruleset_version
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - in: path
        name: ruleset_phase
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - in: path
        name: account_id
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_AccountId'
      responses:
        4XX:
          $ref: '#/components/responses/rulesets_Failure'
        '200':
          $ref: '#/components/responses/rulesets_Ruleset'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
      summary: APIs.io Engineering Platform Get an account entry point ruleset version
      tags:
      - Account Rulesets
      x-cfPlanAvailability:
        business: true
        enterprise: true
        free: true
        pro: true
components:
  schemas:
    rulesets_ResponseRules:
      description: The list of rules in the ruleset.
      items:
        $ref: '#/components/schemas/rulesets_ResponseRule'
      title: Rules
      type: array
    rulesets_RulesetId:
      description: The unique ID of the ruleset.
      example: 2f2feab2026849078ba485f918791bdc
      pattern: ^[0-9a-f]{32}$
      title: ID
      type: string
    rulesets_ExecuteRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - properties:
          action:
            enum:
            - execute
          action_parameters:
            properties:
              id:
                allOf:
                - $ref: '#/components/schemas/rulesets_RulesetId'
                - description: The ID of the ruleset to execute.
                  example: 4814384a9e5d4991b9815dcfc25d2f1f
              matched_data:
                description: The configuration to use for matched data logging.
                properties:
                  public_key:
                    description: The public key to encrypt matched data logs with.
                    example: iGqBmyIUxuWt1rvxoAharN9FUXneUBxA/Y19PyyrEG0=
                    minLength: 1
                    title: Public key
                    type: string
                required:
                - public_key
                title: Matched data
                type: object
              overrides:
                description: A set of overrides to apply to the target ruleset.
                minProperties: 1
                properties:
                  action:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_RuleAction'
                    - description: An action to override all rules with. This option has lower precedence than rule and category overrides.
                      example: log
                  categories:
                    description: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
                    items:
                      description: A category-level override
                      minProperties: 2
                      properties:
                        action:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleAction'
                          - description: The action to override rules in the category with.
                            example: log
                        category:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleCategory'
                          - description: The name of the category to override.
                        enabled:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleEnabled'
                          - description: Whether to enable execution of rules in the category.
                        sensitivity_level:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                          - description: The sensitivity level to use for rules in the category.
                      required:
                      - category
                      title: Category override
                      type: object
                    minItems: 1
                    title: Category overrides
                    type: array
                    uniqueItems: true
                  enabled:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_RuleEnabled'
                    - description: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
                  rules:
                    description: A list of rule-level overrides. This option has the highest precedence.
                    items:
                      description: A rule-level override
                      minProperties: 2
                      properties:
                        action:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleAction'
                          - description: The action to override the rule with.
                            example: log
                        enabled:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleEnabled'
                          - description: Whether to enable execution of the rule.
                        id:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleId'
                          - description: The ID of the rule to override.
                            example: 8ac8bc2a661e475d940980f9317f28e1
                        score_threshold:
                          description: The score threshold to use for the rule.
                          title: Score threshold
                          type: integer
                        sensitivity_level:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                          - description: The sensitivity level to use for the rule.
                      required:
                      - id
                      title: Rule override
                      type: object
                    minItems: 1
                    title: Rule overrides
                    type: array
                    uniqueItems: true
                  sensitivity_level:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                    - description: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.
                title: Overrides
                type: object
            required:
            - id
          description:
            example: Execute the OWASP ruleset when the IP address is not 1.1.1.1
        title: Execute rule
    rulesets_Messages:
      description: A list of warning messages.
      items:
        $ref: '#/components/schemas/rulesets_Message'
      title: Messages
      type: array
    rulesets_Ruleset:
      description: A ruleset object.
      properties:
        description:
          default: ''
          description: An informative description of the ruleset.
          example: My ruleset to execute managed rulesets
          title: Description
          type: string
        id:
          allOf:
          - $ref: '#/components/schemas/rulesets_RulesetId'
          - readOnly: true
        last_updated:
          description: The timestamp of when the ruleset was last modified.
          example: '2000-01-01T00:00:00.000000Z'
          format: date-time
          readOnly: true
          title: Last updated
          type: string
        name:
          description: The human-readable name of the ruleset.
          example: My ruleset
          minLength: 1
          title: Name
          type: string
        version:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      required:
      - id
      - version
      - last_updated
      title: Ruleset
      type: object
    rulesets_DDoSDynamicRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - properties:
          action:
            enum:
            - ddos_dynamic
          description:
            example: Performs a specific action according to a set of internal guidelines defined by Cloudflare.
        title: DDoS Dynamic rule
    rulesets_RuleCategory:
      description: A category of the rule.
      example: directory-traversal
      minLength: 1
      title: Category
      type: string
    rulesets_SkipRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - properties:
          action:
            enum:
            - skip
          action_parameters:
            example:
              ruleset: current
            minProperties: 1
            properties:
              phases:
                description: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
                items:
                  allOf:
                  - $ref: '#/components/schemas/rulesets_RulesetPhase'
                  - description: A phase to skip the execution of.
                minItems: 1
                title: Phases
                type: array
                uniqueItems: true
              products:
                description: A list of legacy security products to skip the execution of.
                items:
                  description: The name of a legacy security product to skip the execution of.
                  enum:
                  - bic
                  - hot
                  - rateLimit
                  - securityLevel
                  - uaBlock
                  - waf
                  - zoneLockdown
                  title: Product
                  type: string
                minItems: 1
                title: Products
                type: array
                uniqueItems: true
              rules:
                additionalProperties:
                  description: A list of rule IDs in the ruleset to skip the execution of.
                  items:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_RuleId'
                    - description: The ID of a rule in the ruleset to skip the execution of.
                      example: 8ac8bc2a661e475d940980f9317f28e1
                      title: Rule
                  minItems: 1
                  title: Rules
                  type: array
                  uniqueItems: true
                description: A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the

# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apis-io-engineering-platform/refs/heads/main/openapi/engineering-platform-account-rulesets-api-openapi.yml