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

# Get Requests

> Project-scoped operation. Successful JSON and status-only responses vary by operation. The service does not declare a stable response schema for this operation; do not assume a collection envelope or undocumented fields.



## OpenAPI

````yaml /openapi-shield.json get /shield/domains/{domain_id}/requests
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}/requests:
    get:
      tags:
        - Cloud Shield Analytics
      summary: Get Requests
      description: >-
        Project-scoped operation. Successful JSON and status-only responses vary
        by operation. The service does not declare a stable response schema for
        this operation; do not assume a collection envelope or undocumented
        fields.
      operationId: GET_shield_domains_domain_id_requests
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: integer
            title: Domain Id
        - name: ordering
          in: query
          required: false
          schema:
            type: string
            title: Ordering
        - name: ip
          in: query
          required: false
          schema:
            title: Ip
            anyOf:
              - type: string
                format: ipvanyaddress
              - type: 'null'
        - name: reference_id
          in: query
          required: false
          schema:
            type: string
            example: ad07c06f19054e484974fa22e9fb6bb1
            title: Reference Id
        - name: status_code
          in: query
          required: false
          schema:
            type: integer
            minimum: 100
            maximum: 599
            title: Status Code
        - name: security_rule_name
          in: query
          required: false
          schema:
            type: string
            maxLength: 100
            title: Security Rule Name
        - name: countries
          in: query
          required: false
          schema:
            type: array
            title: Countries
            items:
              type: string
          style: form
          explode: true
        - name: actions
          in: query
          required: false
          schema:
            type: array
            title: Actions
            items:
              type: string
              enum:
                - allow
                - block
                - captcha
                - handshake
              title: EventAction
          style: form
          explode: true
        - name: traffic_types
          in: query
          required: false
          schema:
            type: array
            title: Traffic Types
            items:
              type: string
              enum:
                - policy_allowed
                - policy_blocked
                - custom_rule_allowed
                - custom_blocked
                - legit_requests
                - sanctioned
                - dynamic
                - api
                - static
                - ajax
                - redirects
                - monitor
                - err_40x
                - err_50x
                - passed_to_origin
                - timeout
                - other
                - ddos
                - legit
                - monitored
              title: TrafficType
          style: form
          explode: true
        - name: has_policy_override
          in: query
          required: false
          schema:
            title: Has Policy Override
            anyOf:
              - type: boolean
              - type: 'null'
        - name: start
          in: query
          required: true
          schema:
            type: string
            example: '2024-04-13T00:00:00+01:00'
            title: Start
        - name: end
          in: query
          required: false
          schema:
            title: End
            anyOf:
              - type: string
              - 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
      responses:
        2XX:
          description: Successful response.
        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'
      deprecated: true
components:
  schemas:
    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.