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

# Retrieve a domains's custom rules

> Project-scoped operation. Resource fields may include additional operation-specific values.



## OpenAPI

````yaml /openapi-shield.json get /shield/domains/{domain_id}/custom-rules
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}/custom-rules:
    get:
      tags:
        - Cloud Shield Custom Rules
      summary: Retrieve a domains's custom rules
      description: >-
        Project-scoped operation. Resource fields may include additional
        operation-specific values.
      operationId: GET_shield_domains_domain_id_custom_rules
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: integer
            title: Domain Id
        - name: ordering
          in: query
          required: false
          schema:
            title: Ordering
            anyOf:
              - type: string
                enum:
                  - id
                  - name
                  - description
                  - enabled
                  - action
                  - '-id'
                  - '-name'
                  - '-description'
                  - '-enabled'
                  - '-action'
              - type: 'null'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 100
            minimum: 0
            maximum: 100
            title: Limit
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            default: 0
            minimum: 0
            maximum: 100000
            title: Offset
        - name: name
          in: query
          required: false
          schema:
            type: string
            example: Block by specific IP rule.
            title: Name
        - name: description
          in: query
          required: false
          schema:
            type: string
            example: >-
              This rule blocks all the requests coming form a specific IP
              address.
            title: Description
        - name: action
          in: query
          required: false
          schema:
            type: string
            enum:
              - allow
              - block
              - captcha
              - handshake
              - monitor
              - tag
            title: RuleActionType
        - name: enabled
          in: query
          required: false
          schema:
            type: boolean
            example: false
            title: Enabled
      responses:
        2XX:
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Rule'
                  count:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
                required:
                  - results
                  - count
        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:
    Rule:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
        name:
          type: string
        description:
          type: string
        enabled:
          type: boolean
        action:
          type: object
        conditions:
          type: array
          items:
            type: object
        source:
          type: string
        phase:
          type: string
    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.