> ## 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.

# Get CVM network info

> Returns network status including internal IP, handshake time, and public URLs.



## OpenAPI

````yaml /openapi.json get /api/v1/cvms/{cvm_id}/network
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/cvms/{cvm_id}/network:
    get:
      tags:
        - CVMs
      summary: Get CVM network info
      description: >-
        Returns network status including internal IP, handshake time, and public
        URLs.
      operationId: handle_get_cvm_network_info_api_v1_cvms__cvm_id__network_get
      parameters:
        - name: cvm_id
          in: path
          required: true
          schema:
            type: string
            title: Cvm Id
      responses:
        '200':
          description: Network info (may have error if offline)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CvmNetwork'
        '401':
          description: Authentication required
        '403':
          description: Access denied
        '404':
          description: CVM not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CvmNetwork:
      properties:
        is_online:
          type: boolean
          title: Is Online
        is_public:
          type: boolean
          title: Is Public
          default: true
        error:
          anyOf:
            - type: string
            - type: 'null'
          title: Error
        internal_ip:
          anyOf:
            - type: string
            - type: 'null'
          title: Internal Ip
        latest_handshake:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Latest Handshake
        public_urls:
          anyOf:
            - items:
                $ref: '#/components/schemas/CvmNetworkUrls'
              type: array
            - type: 'null'
          title: Public Urls
      type: object
      required:
        - is_online
      title: CvmNetwork
      description: Model representing CVM network information
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CvmNetworkUrls:
      properties:
        app:
          type: string
          title: App
        instance:
          type: string
          title: Instance
      type: object
      required:
        - app
        - instance
      title: CvmNetworkUrls
      description: Model representing public URLs for a CVM port
    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

````