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

# List family instance types

> Public endpoint. Returns all public instance types for a specific family.



## OpenAPI

````yaml /openapi.json get /api/v1/instance-types/{family}
openapi: 3.1.0
info:
  title: Phala Cloud API
  version: 0.1.0
servers:
  - url: https://cloud-api.phala.com
security: []
tags:
  - name: CVMs
    description: Confidential Virtual Machine (CVM) lifecycle management on Phala Network
  - name: Apps
    description: App template management and CVM deployment from app blueprints
  - name: Webhooks
    description: Manage webhook endpoints and monitor delivery history
  - name: SSH Keys
    description: SSH public key management for CVM access
  - name: KMS
    description: >-
      Key Management Service — key derivation, on-chain anchoring, and
      inspection
  - name: Instance Types
    description: Available hardware configurations for CVM deployment
  - name: Attestations
    description: Remote attestation and TEE verification endpoints
paths:
  /api/v1/instance-types/{family}:
    get:
      tags:
        - Instance Types
      summary: List family instance types
      description: >-
        Public endpoint. Returns all public instance types for a specific
        family.
      operationId: list_family_instance_types_api_v1_instance_types__family__get
      parameters:
        - name: family
          in: path
          required: true
          schema:
            type: string
            description: Family name (cpu, gpu)
            title: Family
          description: Family name (cpu, gpu)
      responses:
        '200':
          description: Instance types for family
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FamilyInstanceTypesResponse'
        '404':
          description: Family not found or empty
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Database error
components:
  schemas:
    FamilyInstanceTypesResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/InstanceTypePublic'
          type: array
          title: Items
          description: Instance types
        total:
          type: integer
          title: Total
          description: Total count
        family:
          type: string
          title: Family
          description: Family name
      type: object
      required:
        - items
        - total
        - family
      title: FamilyInstanceTypesResponse
      description: Instance types for one family.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    InstanceTypePublic:
      properties:
        id:
          type: string
          title: Id
          description: Instance type identifier
        name:
          type: string
          title: Name
          description: Display name
        description:
          type: string
          title: Description
          description: Type description
        vcpu:
          type: integer
          title: Vcpu
          description: Virtual CPU count
        memory_mb:
          type: integer
          title: Memory Mb
          description: Memory in megabytes
        hourly_rate:
          type: string
          title: Hourly Rate
          description: USD per hour as decimal string
        requires_gpu:
          type: boolean
          title: Requires Gpu
          description: Whether GPU is required
        default_disk_size_gb:
          type: integer
          title: Default Disk Size Gb
          description: Default disk size in GB
          default: 20
        family:
          anyOf:
            - type: string
            - type: 'null'
          title: Family
          description: Family category (cpu, gpu)
      type: object
      required:
        - id
        - name
        - description
        - vcpu
        - memory_mb
        - hourly_rate
        - requires_gpu
      title: InstanceTypePublic
      description: Public instance type specification.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````