> ## 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.

# List delivery rules



## OpenAPI

````yaml /openapi-products.json get /cloud-cdn/distributions/rules
openapi: 3.1.0
info:
  title: Aptranet delivery controls and TLS Manager
  version: 1.0.0
  description: >-
    Public project-scoped API. Use the access key and secret together.
    Browser-only organization administration is documented separately.
servers:
  - url: https://api.aptranet.com
security:
  - bearerAuth: []
    apiSecret: []
paths:
  /cloud-cdn/distributions/rules:
    get:
      tags:
        - CDN delivery rules
      summary: List delivery rules
      operationId: GET_cloud_cdn_distributions_rules
      parameters:
        - name: distribution
          in: query
          required: true
          schema:
            type: integer
            minimum: 1
      responses:
        '200':
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rules:
                    type: array
                    items:
                      $ref: '#/components/schemas/DeliveryRule'
                  limit:
                    type: integer
                required:
                  - rules
                  - limit
        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:
    DeliveryRule:
      allOf:
        - $ref: '#/components/schemas/DeliveryRuleWrite'
        - type: object
          properties:
            id:
              type: integer
              minimum: 1
            rule_type:
              type: integer
    Error:
      type: object
      properties:
        error:
          type: string
        error_description:
          type: string
    DeliveryRuleWrite:
      type: object
      properties:
        name:
          type: string
          maxLength: 255
        pattern:
          type: string
          maxLength: 300
          description: Path or expression starting with / or ^/. No hostname or whitespace.
        weight:
          type: integer
          minimum: 0
          maximum: 100000
          default: 1
        active:
          type: boolean
          default: true
        origin_protocol:
          type: string
          enum:
            - ''
            - INHERIT
            - HTTP
            - HTTPS
            - MATCH
        options:
          type: object
          additionalProperties: false
          properties:
            allowedHttpMethods:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            brotli_compression:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            browser_cache_settings:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            cors:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            country_acl:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            disable_proxy_force_ranges:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            edge_cache_settings:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            fetch_compressed:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            follow_origin_redirect:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            force_return:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            forward_host_header:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            gzipOn:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            hostHeader:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            ignore_cookie:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            ignoreQueryString:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            image_stack:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            ip_address_acl:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            limit_bandwidth:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            proxy_cache_key:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            proxy_cache_methods_set:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            proxy_connect_timeout:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            proxy_read_timeout:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            query_params_blacklist:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            query_params_whitelist:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            query_string_forwarding:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            redirect_http_to_https:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            redirect_https_to_http:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            referrer_acl:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            response_headers_hiding_policy:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            rewrite:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            secure_key:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            slice:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            sni:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            stale:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            static_response_headers:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            staticHeaders:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            staticRequestHeaders:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            user_agent_acl:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
            websockets:
              type:
                - object
                - 'null'
              description: >-
                Option-specific configuration. Read the existing rule and
                preserve fields when editing.
      required:
        - name
        - pattern
  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.