WireguardInterfaceCreate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-wireguard-interface-create-schema.json",
  "title": "WireguardInterfaceCreate",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-wireguard-interfaces-api-openapi.yml#/components/schemas/WireguardInterfaceCreate",
  "allOf": [
    {
      "$ref": "#/$defs/WireguardInterface"
    },
    {
      "$ref": "#/$defs/RegionIn"
    },
    {
      "required": [
        "network_id",
        "region_code"
      ],
      "title": "WireguardInterfaceCreate",
      "type": "object"
    }
  ],
  "$defs": {
    "Interface": {
      "properties": {
        "name": {
          "description": "A user specified name for the interface.",
          "type": "string"
        },
        "network_id": {
          "description": "The id of the network associated with the interface.",
          "format": "uuid",
          "type": "string"
        },
        "status": {
          "$ref": "#/$defs/InterfaceStatus"
        }
      },
      "type": "object"
    },
    "InterfaceStatus": {
      "description": "The current status of the interface deployment.",
      "enum": [
        "created",
        "provisioning",
        "provisioned",
        "deleting"
      ],
      "readOnly": true,
      "type": "string"
    },
    "Record": {
      "properties": {
        "created_at": {
          "description": "ISO 8601 formatted date-time indicating when the resource was created.",
          "readOnly": true,
          "type": "string"
        },
        "id": {
          "description": "Identifies the resource.",
          "format": "uuid",
          "readOnly": true,
          "type": "string"
        },
        "record_type": {
          "description": "Identifies the type of the resource.",
          "readOnly": true,
          "type": "string"
        },
        "updated_at": {
          "description": "ISO 8601 formatted date-time indicating when the resource was updated.",
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "RegionIn": {
      "properties": {
        "region_code": {
          "description": "The region the interface should be deployed to.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "WireguardInterface": {
      "allOf": [
        {
          "$ref": "#/$defs/Record"
        },
        {
          "$ref": "#/$defs/Interface"
        },
        {
          "properties": {
            "enable_sip_trunking": {
              "description": "Enable SIP traffic forwarding over VPN interface.",
              "type": "boolean"
            },
            "endpoint": {
              "description": "The Telnyx WireGuard peers `Peer.endpoint` value.",
              "readOnly": true,
              "type": "string"
            },
            "public_key": {
              "description": "The Telnyx WireGuard peers `Peer.PublicKey`.",
              "readOnly": true,
              "type": "string"
            },
            "record_type": {
              "description": "Identifies the type of the resource.",
              "readOnly": true,
              "type": "string"
            }
          },
          "title": "WireguardInterface",
          "type": "object"
        }
      ]
    }
  }
}