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

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



## OpenAPI

````yaml /openapi-shield.json get /shield/domains
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:
    get:
      tags:
        - Cloud Shield Domains
      summary: List Domains
      description: >-
        Project-scoped operation. Resource fields may include additional
        operation-specific values.
      operationId: GET_shield_domains
      parameters:
        - name: ordering
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
              - name
              - status
              - created_at
              - '-id'
              - '-name'
              - '-status'
              - '-created_at'
              - total_requests
              - '-total_requests'
              - attacks_detected
              - '-attacks_detected'
            title: Ordering
        - 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: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - bypass
              - monitor
              - locked
            title: DomainStatus
        - name: name
          in: query
          required: false
          schema:
            type: string
            example: '*example.com'
            title: Name
        - name: ids
          in: query
          required: false
          schema:
            type: array
            example: 1
            title: Ids
            items:
              type: integer
          style: form
          explode: true
      responses:
        2XX:
          description: Successful response.
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Domain'
                  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:
    Domain:
      type: object
      properties:
        id:
          type: integer
          minimum: 1
        name:
          type: string
        status:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      required:
        - id
        - name
        - status
    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.