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

# List Endpoints



## OpenAPI

````yaml openapi.json GET /endpoints
openapi: 3.1.0
info:
  title: AirCloud External API
  description: Public REST API for managing AirCloud endpoints programmatically.
  version: 1.0.0
  contact:
    name: support
    url: https://aieev.com
    email: support@aieev.cloud
servers:
  - url: https://external.aieev.cloud:5007/external/api/v1
security:
  - bearerAuth: []
tags:
  - name: Authentication
    description: Verify API key context.
  - name: Endpoints
    description: 'Manage endpoints: list, start, stop, scale, and patch.'
  - name: Replicas
    description: View live replica status.
  - name: Logs
    description: Access endpoint log files.
paths:
  /endpoints:
    get:
      tags:
        - Endpoints
      summary: List Endpoints
      description: Returns a paginated list of endpoints accessible by the current API key.
      operationId: listEndpoints
      parameters:
        - name: search
          in: query
          description: Search endpoints by name.
          schema:
            type: string
            example: my-model
        - name: is_active
          in: query
          description: >-
            Filter by active status. `true` returns only running endpoints,
            `false` returns only stopped endpoints.
          schema:
            type: boolean
            example: true
        - name: page
          in: query
          description: Page number, starting from 1.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: size
          in: query
          description: Number of items per page. Min 1, max 2000.
          schema:
            type: integer
            minimum: 1
            maximum: 2000
            default: 50
      responses:
        '200':
          description: Paginated list of endpoints.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointListResponse'
        '401':
          description: Missing or invalid API key.
components:
  schemas:
    EndpointListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/EndpointListItem'
          description: Array of endpoint objects.
        total:
          type: integer
          description: Total number of endpoints.
          example: 5
        page:
          type: integer
          description: Current page number.
          example: 1
        size:
          type: integer
          description: Items per page.
          example: 50
        pages:
          type: integer
          description: Total number of pages.
          example: 1
    EndpointListItem:
      type: object
      properties:
        id:
          type: string
          description: Unique endpoint ID.
          example: cad59665-b77b-4cb6-9308-d276294bce79
        name:
          type: string
          description: Endpoint name.
          example: my-llm-endpoint
        endpoint_type:
          type: string
          description: Endpoint type.
          example: container
        is_active:
          type: boolean
          description: Whether the endpoint is currently active (running).
          example: true
        status:
          type: string
          description: Current status (RUNNING, STOPPED, DEPLOYING, etc.).
          example: RUNNING
        num_replicas:
          type: integer
          description: Current number of replicas.
          example: 2
        enable_autoscaling:
          type: boolean
          description: Whether autoscaling is enabled.
          example: false
        instance_type_name:
          type: string
          nullable: true
          description: Assigned instance type name.
          example: RTX 4070 Super
        serving_endpoint_url:
          type: string
          nullable: true
          description: Public URL for the endpoint.
          example: https://ap-1.aieev.cloud/ac/7/cad59665-b77b-4cb6-9308-d276294bce79
        created_at:
          type: string
          format: date-time
          description: Creation time (ISO 8601).
        updated_at:
          type: string
          format: date-time
          description: Last update time (ISO 8601).
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Pass your API key as a Bearer token. Create API keys in the project
        overview.

````