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

# Get VPC

> Get details of a single VPC. The response wraps the core VPC fields under `data.vpc` and includes additional detail fields (`ip_range_start`, `ip_range_end`, `leases`) at the same level.


<sub>Updated May 8, 2026</sub>


## OpenAPI

````yaml GET /api/v1/vpcs/{id}
openapi: 3.0.3
info:
  title: Raff API
  description: >
    REST API for managing cloud infrastructure on Raff.


    ## Authentication

    Most endpoints require authentication via API key. Catalog endpoints under
    `/api/v1/public/` are open and require no authentication.


    ### API Key Authentication

    Include your API key in the `X-API-Key` header:
      ```
      curl -H "X-API-Key: YOUR_API_KEY" https://api.rafftechnologies.com/api/v1/vms
      ```

    ## Catalog

    Use the public catalog endpoints to discover available regions, OS
    templates, and pricing plans before creating resources:

    - `GET /api/v1/public/regions` — list available regions

    - `GET /api/v1/public/templates` — list OS templates (use the `id` as
    `template_id` when creating a VM)

    - `GET /api/v1/public/pricing/vm` — list VM pricing plans (use the `id` as
    `pricing_id` when creating a VM)

    - `GET /api/v1/public/pricing/volume` — volume storage pricing

    - `GET /api/v1/public/pricing/snapshot` — snapshot storage pricing

    - `GET /api/v1/public/pricing/backup` — backup storage pricing

    - `GET /api/v1/public/pricing/ip` — IP address pricing
  version: 1.0.0
  contact:
    name: Raff Technologies
    url: https://rafftechnologies.com
servers:
  - url: https://api.rafftechnologies.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog
    description: >-
      Discover available regions, OS templates, and pricing plans. No
      authentication required.
  - name: Health
    description: Health check endpoints
  - name: Projects
    description: Organize resources into projects for billing and access control
  - name: Virtual Machines
    description: Create, manage, and control virtual machines
  - name: Networking
    description: >-
      Attach and detach VPCs, floating IPs, and security groups to VM network
      interfaces
  - name: Snapshots
    description: Point-in-time copies of VMs and volumes for quick rollback or cloning
  - name: Backups
    description: Scheduled and on-demand VM backups with restore capability
  - name: Backup Schedules
    description: Recurring daily or weekly backup schedules attached to a VM
  - name: SSH Keys
    description: Manage account-level SSH keys for VM provisioning
  - name: Members
    description: Account-level members — invite, list, update role, remove
  - name: Project Members
    description: Members of a specific project — same model as Members but project-scoped
  - name: Roles
    description: Custom roles bundling account or project permissions
  - name: Permissions
    description: List the catalog of permission strings used by roles
  - name: API Keys
    description: Create and manage API keys for programmatic access
  - name: Invitations
    description: Create and cancel email-based invitations to join the account or a project
paths:
  /api/v1/vpcs/{id}:
    get:
      tags:
        - Networking
      summary: Get VPC
      description: >
        Get details of a single VPC. The response wraps the core VPC fields
        under `data.vpc` and includes additional detail fields
        (`ip_range_start`, `ip_range_end`, `leases`) at the same level.
      operationId: getVPC
      parameters:
        - $ref: '#/components/parameters/VPCIDPath'
        - $ref: '#/components/parameters/ProjectIDHeader'
      responses:
        '200':
          description: VPC details
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/VPCDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    VPCIDPath:
      name: id
      in: path
      required: true
      description: VPC ID (UUID).
      schema:
        type: string
        format: uuid
    ProjectIDHeader:
      name: X-Project-ID
      in: header
      required: true
      description: >-
        Project ID. Required for all mutating operations (create, delete, power
        actions, resize).
      schema:
        type: string
        format: uuid
  schemas:
    VPCDetail:
      type: object
      description: >
        Detail wrapper returned by `GET /api/v1/vpcs/{id}`. Contains the core
        VPC under `vpc`, plus the configured IP range and the current set of IP
        leases (one entry per attached network interface).
      required:
        - vpc
      properties:
        vpc:
          $ref: '#/components/schemas/VPC'
        ip_range_start:
          type: string
          description: First IP in the VPC's allocatable range
          example: 10.0.1.10
        ip_range_end:
          type: string
          description: Last IP in the VPC's allocatable range
          example: 10.0.1.254
        leases:
          type: array
          description: Active IP leases on the VPC. Empty when no VMs are attached.
          items:
            $ref: '#/components/schemas/VPCLease'
    VPC:
      type: object
      description: A virtual private cloud (VPC).
      required:
        - id
        - name
        - cidr
        - status
        - region
      properties:
        id:
          type: string
          format: uuid
          description: VPC identifier.
        account_id:
          type: string
          format: uuid
          description: Account this VPC belongs to.
        project_id:
          type: string
          format: uuid
          description: Project this VPC belongs to.
        name:
          type: string
          description: VPC display name.
          example: vpc-prod
        cidr:
          type: string
          description: CIDR block for the VPC.
          example: 10.0.0.0/24
        gateway:
          type: string
          description: Gateway IP for the VPC.
          example: 10.0.0.1
        dns:
          type: string
          description: DNS server IP for the VPC.
        status:
          type: string
          description: VPC lifecycle status.
          example: active
        total_ips:
          type: integer
          description: Total addressable IPs in the VPC.
          example: 256
        used_ips:
          type: integer
          description: IPs currently leased to VMs.
          example: 4
        region:
          type: string
          enum:
            - us-east
          description: Region where the VPC lives.
        gateway_type:
          type: string
          description: Gateway type (e.g. `none`, `nat`).
        router_public_ip:
          type: string
          description: Public IP of the VPC gateway, if a gateway is enabled.
        router_status:
          type: string
          description: Gateway router status.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    VPCLease:
      type: object
      description: A single IP lease on the VPC.
      required:
        - ip
        - nic_id
      properties:
        ip:
          type: string
          description: Leased IP address
          example: 10.0.1.42
        nic_id:
          type: integer
          description: >-
            NIC interface ID on the leased VM. Pair with `GET
            /api/v1/vms/{id}/networks` to identify the owning interface.
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication. Each key is bound to a specific account.

````