RArafftechnologies
Networking

Get VPC

Changed on

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.

get/api/v1/vpcs/{id}

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/vpcs/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring uuid required

VPC ID (UUID).

Headers

X-Project-IDstring uuid required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Response

VPC details

successboolean

Example response

{
  "data": {
    "vpc": {
      "name": "vpc-prod",
      "cidr": "10.0.0.0/24",
      "gateway": "10.0.0.1",
      "status": "active",
      "total_ips": 256,
      "used_ips": 4
    },
    "ip_range_start": "10.0.1.10",
    "ip_range_end": "10.0.1.254",
    "leases": [
      {
        "ip": "10.0.1.42"
      }
    ]
  }
}

Changes

  • 571a3b76415cRevision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

  • 9e13a6e23934Revision changes
    • info

      endpoint added