> ## 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 Scan Results

> Project-scoped operation. Requires the api_security add-on. 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}/api-discovery/scan-results
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}/api-discovery/scan-results:
    get:
      tags:
        - Cloud Shield API Discovery
      summary: Get Scan Results
      description: >-
        Project-scoped operation. Requires the api_security add-on. 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_api_discovery_scan_results
      parameters:
        - name: domain_id
          in: path
          required: true
          schema:
            type: integer
            title: Domain Id
        - name: ordering
          in: query
          required: false
          schema:
            type: string
            enum:
              - id
              - type
              - start_time
              - end_time
              - status
              - message
              - '-id'
              - '-type'
              - '-start_time'
              - '-end_time'
              - '-status'
              - '-message'
            default: '-start_time'
            title: Ordering
        - name: type
          in: query
          required: false
          schema:
            title: Type
            anyOf:
              - type: string
                enum:
                  - TRAFFIC_SCAN
                  - API_DESCRIPTION_FILE_SCAN
                title: ApiScanType
              - type: 'null'
        - name: status
          in: query
          required: false
          schema:
            title: Status
            anyOf:
              - type: string
                enum:
                  - SUCCESS
                  - FAILURE
                  - IN_PROGRESS
                title: TaskResultStatus
              - type: 'null'
        - name: message
          in: query
          required: false
          schema:
            title: Message
            anyOf:
              - type: string
                maxLength: 1024
              - 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'
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.