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

# List Instances



## OpenAPI

````yaml api-reference/gpus-v2-spec/list-instances.json GET /gpus/v2/instances
openapi: 3.0.0
info:
  title: Novita GPU API v2
  version: 2.0.0
servers:
  - url: https://api.novita.ai
security: []
paths:
  /gpus/v2/instances:
    get:
      summary: List Instances
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
          description: 'Bearer authentication format, e.g.: `Bearer {{API_KEY}}`.'
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: >-
            Maximum number of items to return. Uses the server default when
            omitted or 0. Integer, value >= 0.
          example: 20
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Cursor for the next page. Leave empty for the first request, then
            pass the `next_cursor` from the previous response. String, length:
            0-1024 characters.
        - name: name
          in: query
          required: false
          schema:
            type: string
          description: >-
            Fuzzy match on instance name or ID. String, length: 0-255
            characters.
          example: example
        - name: status
          in: query
          required: false
          schema:
            type: string
          description: 'Filter by instance status. String, length: 0-63 characters.'
          example: running
        - name: regions
          in: query
          required: false
          schema:
            type: string
          description: >-
            Filter by region. Multiple regions are comma-separated. String,
            length: 0-1024 characters.
          example: region-id
        - name: billing_mode
          in: query
          required: false
          schema:
            type: string
            enum:
              - postpaid
              - prepaid
              - spot
          description: >-
            Filter by billing mode. Allowed values: `postpaid`, `prepaid`,
            `spot`. Use an empty string to skip filtering.
          example: prepaid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Instance list
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Instance ID
                          example: ca338f12f3
                        name:
                          type: string
                          description: Instance name
                          example: example-instance
                        type:
                          type: string
                          enum:
                            - gpu
                            - cpu
                          description: 'Instance type. Allowed values: `gpu`, `cpu`'
                          example: gpu
                        product_id:
                          type: string
                          description: Product ID
                          example: product-id
                        image:
                          type: string
                          description: Image address
                          example: registry.example.com/namespace/image:tag
                        registry_auth_id:
                          type: string
                          description: Registry authentication ID
                          example: registry-auth-id
                        entrypoint:
                          type: string
                          description: Container entrypoint
                          example: ''
                        command:
                          type: string
                          description: Container startup command
                          example: ''
                        billing:
                          type: object
                          description: Billing configuration
                          properties:
                            mode:
                              type: string
                              enum:
                                - postpaid
                                - prepaid
                                - spot
                              description: >-
                                Billing mode. Allowed values: `postpaid`,
                                `prepaid`, `spot`
                              example: prepaid
                            prepaid:
                              type: object
                              description: >-
                                Monthly subscription configuration. Present when
                                `mode=prepaid`
                              properties:
                                months:
                                  type: integer
                                  description: Subscription length in months
                                  example: 1
                                end_time:
                                  type: integer
                                  description: Subscription end time. Unix timestamp
                                auto_renew:
                                  type: object
                                  description: Auto-renew configuration
                                  properties:
                                    enabled:
                                      type: boolean
                                      description: Whether auto-renew is enabled
                                      example: true
                                    months:
                                      type: integer
                                      description: Auto-renew length in months
                                      example: 1
                                    status:
                                      type: string
                                      description: Auto-renew status
                                      example: active
                        envs:
                          type: array
                          description: Environment variable list
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: Variable name
                                example: ENV_NAME
                              value:
                                type: string
                                description: Variable value
                                example: ENV_VALUE
                        ports:
                          type: array
                          description: Exposed port list
                          items:
                            type: object
                            properties:
                              port:
                                type: integer
                                description: Port number
                                example: 8080
                              protocol:
                                type: string
                                description: Port protocol
                                example: tcp
                              endpoint:
                                type: string
                                description: External endpoint (assigned at runtime)
                                example: http://1.2.3.4:8080
                        resource_specs:
                          type: object
                          description: Resource specification (with system-allocated info)
                          properties:
                            rootfs_size_gb:
                              type: integer
                              description: 'Root disk size. Unit: GB'
                              example: 20
                            gpu_num:
                              type: integer
                              description: GPU count
                              example: 1
                            cpu_num:
                              type: integer
                              description: CPU cores (system-allocated)
                              example: 8
                            memory_gb:
                              type: integer
                              description: 'Memory size. Unit: GB (system-allocated)'
                              example: 32
                            gpu_ids:
                              type: array
                              items:
                                type: integer
                              description: Allocated GPU card indices
                              example:
                                - 0
                        network:
                          type: object
                          description: VPC network configuration
                          properties:
                            id:
                              type: string
                              description: VPC network ID
                              example: ''
                            ip:
                              type: string
                              description: IP assigned to the instance by the VPC
                              example: 10.2.1.1
                        volumes:
                          type: array
                          description: Data disk / network storage mounts
                          items:
                            type: object
                            properties:
                              type:
                                type: string
                                enum:
                                  - local
                                  - network
                                description: >-
                                  Storage type. Allowed values: `local`,
                                  `network`
                                example: network
                              id:
                                type: string
                                description: Storage ID. Used for `network` type
                                example: network-storage-id
                              mount_point:
                                type: string
                                description: Mount path
                                example: /data
                        region:
                          type: string
                          description: Region of the instance
                          example: region-id
                        auto_migrate:
                          type: object
                          description: Auto-migrate configuration
                          properties:
                            enabled:
                              type: boolean
                              description: Whether auto-migrate is enabled
                              example: false
                            include_system_disk:
                              type: boolean
                              description: >-
                                Whether the system disk is included during
                                auto-migrate
                              example: false
                        status:
                          type: object
                          description: Instance status information
                          properties:
                            status:
                              type: string
                              description: Instance status
                              example: running
                            error:
                              type: string
                              description: Error code
                              example: ''
                            message:
                              type: string
                              description: Status description
                              example: ''
                        created_at:
                          type: integer
                          description: Creation time. Unix timestamp
                          example: 1714464000
                        last_started_at:
                          type: integer
                          description: Last start time. Unix timestamp
                          example: 1714467600
                        last_stopped_at:
                          type: integer
                          description: Last stop time. Unix timestamp
                          example: 0
                        member_id:
                          type: string
                          description: Creator member ID
                          example: member-id
                        owner_id:
                          type: string
                          description: Owner user ID (team owner UUID)
                          example: 550e8400-e29b-41d4-a716-446655440000
                        region_version:
                          type: string
                          description: Instance version
                          example: v1
                  next_cursor:
                    type: string
                    description: >-
                      Cursor for the next page. Empty string when there is no
                      next page
                    example: next-cursor-token
                  has_more:
                    type: boolean
                    description: Whether there are more pages
                    example: true

````