> ## 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 API paths

> 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-paths
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-paths:
    get:
      tags:
        - Cloud Shield API Discovery
      summary: List API paths
      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_paths
      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
              - path
              - method
              - api_version
              - http_scheme
              - first_detected
              - last_detected
              - status
              - source
              - '-id'
              - '-path'
              - '-method'
              - '-api_version'
              - '-http_scheme'
              - '-first_detected'
              - '-last_detected'
              - '-status'
              - '-source'
            title: Ordering
        - name: ids
          in: query
          required: false
          schema:
            title: Ids
            anyOf:
              - type: array
                items:
                  type: string
                  format: uuid
              - type: 'null'
          style: form
          explode: true
        - name: path
          in: query
          required: false
          schema:
            title: Path
            anyOf:
              - type: string
                maxLength: 1024
              - type: 'null'
        - name: method
          in: query
          required: false
          schema:
            title: Method
            anyOf:
              - type: string
                enum:
                  - GET
                  - POST
                  - PUT
                  - PATCH
                  - DELETE
                  - TRACE
                  - HEAD
                  - OPTIONS
                title: ApiPathMethod
              - type: 'null'
        - name: api_version
          in: query
          required: false
          schema:
            title: Api Version
            anyOf:
              - type: string
                maxLength: 32
              - type: 'null'
        - name: http_scheme
          in: query
          required: false
          schema:
            title: Http Scheme
            anyOf:
              - type: string
                enum:
                  - HTTP
                  - HTTPS
                title: ApiPathHttpScheme
              - type: 'null'
        - name: api_group
          in: query
          required: false
          schema:
            title: Api Group
            anyOf:
              - type: string
              - type: 'null'
        - name: status
          in: query
          required: false
          schema:
            title: Status
            anyOf:
              - type: array
                items:
                  type: string
                  enum:
                    - CONFIRMED_API
                    - POTENTIAL_API
                    - NOT_API
                    - DELISTED_API
                  title: ApiPathStatus
              - type: 'null'
          style: form
          explode: true
        - name: source
          in: query
          required: false
          schema:
            title: Source
            anyOf:
              - type: string
                enum:
                  - API_DESCRIPTION_FILE
                  - TRAFFIC_SCAN
                  - USER_DEFINED
                title: ApiPathSource
              - type: 'null'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            default: 10
            minimum: 0
            maximum: 10
            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.