> ## Documentation Index
> Fetch the complete documentation index at: https://tyk.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List edge instances

> Get a list of registered edge instances with optional namespace filtering



## OpenAPI

````yaml /swagger/5.12/ai-studio-swagger.yml get /api/v1/edges
openapi: 3.0.1
info:
  title: Midsommar API
  description: This is the API for the Midsommar user and group management system.
  termsOfService: http://swagger.io/terms/
  contact:
    name: API Support
    url: http://www.swagger.io/support
    email: support@swagger.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
  - url: //localhost:8080/api/v1
security: []
paths:
  /api/v1/edges:
    get:
      tags:
        - edges
      summary: List edge instances
      description: >-
        Get a list of registered edge instances with optional namespace
        filtering
      parameters:
        - name: namespace
          in: query
          description: Filter by namespace
          schema:
            type: string
        - name: status
          in: query
          description: Filter by status (registered, connected, disconnected, unhealthy)
          schema:
            type: string
        - name: page
          in: query
          description: Page number
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          description: Items per page
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.EdgeListResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    api.EdgeListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/api.EdgeResponse'
        meta:
          type: object
          properties:
            page_number:
              type: integer
            page_size:
              type: integer
            total_count:
              type: integer
            total_pages:
              type: integer
    api.ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              title:
                type: string
      description: Error response model
    api.EdgeResponse:
      type: object
      properties:
        attributes:
          type: object
          properties:
            build_hash:
              type: string
            created_at:
              type: string
            edge_id:
              type: string
            last_heartbeat:
              type: string
            last_sync_ack:
              type: string
            loaded_checksum:
              type: string
            loaded_version:
              type: string
            metadata:
              type: object
              additionalProperties: true
            namespace:
              type: string
            session_id:
              type: string
            status:
              type: string
            sync_status:
              type: string
              description: Sync status fields for configuration sync tracking
            updated_at:
              type: string
            version:
              type: string
        id:
          type: string
        type:
          type: string
  securitySchemes:
    BearerAuth:
      type: apiKey
      name: Authorization
      in: header

````