Sign in
WireGuard Interfaces

Create a WireGuard Interface

Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.

post/wireguard_interfaces

Request body

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

created_atstring

ISO 8601 formatted date-time indicating when the resource was created.

updated_atstring

ISO 8601 formatted date-time indicating when the resource was updated.

network_idstring uuid

The id of the network associated with the interface.

namestring

A user specified name for the interface.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

endpointstring

The Telnyx WireGuard peers Peer.endpoint value.

public_keystring

The Telnyx WireGuard peers Peer.PublicKey.

enable_sip_trunkingboolean

Enable SIP traffic forwarding over VPN interface.

region_codestring

The region the interface should be deployed to.

Example request

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "sample_record_type",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "name": "test interface",
  "status": "provisioned",
  "endpoint": "203.0.113.0:51871",
  "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
  "region_code": "ashburn-va"
}

Response

Successful response

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sample_record_type",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "name": "test interface",
    "status": "provisioned",
    "endpoint": "203.0.113.0:51871",
    "public_key": "qF4EqlZq+5JL2IKYY8ij49daYyfKVhevJrcDxdqC8GU=",
    "region_code": "ashburn-va",
    "region": {
      "code": "ashburn-va",
      "name": "Ashburn",
      "record_type": "region"
    }
  }
}

Changes

Changed in 4 of the 47 revisions of this API.42428

  • 8a8c40f458c51121See the full diff
    • ▲

      the data response's property type/format changed from object/ to / for status 202

      response-property-type-changed

    • ●

      removed the optional property data/created_at from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/enable_sip_trunking from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/endpoint from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/id from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/name from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/network_id from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/public_key from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/record_type from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/region from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/region_code from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/status from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/updated_at from the response with the 202 status

      response-optional-property-removed

    • ○

      added WireguardInterface RegionOut to the data response property allOf list for the response status 202

      response-property-all-of-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 50870cc05614113See the full diff
    • ▲

      the data response's property type/format changed from / to object/ for status 202

      response-property-type-changed

    • ○

      added the optional property data/created_at to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/enable_sip_trunking to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/endpoint to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/id to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/name to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/network_id to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/public_key to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/record_type to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/region to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/region_code to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/status to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/updated_at to the response with the 202 status

      response-optional-property-added

    • ○

      removed WireguardInterface RegionOut from the data response property allOf list for the response status 202

      response-property-all-of-removed

  • a144ff96b4ac1121See the full diff
    • ▲

      the data response's property type/format changed from object/ to / for status 202

      response-property-type-changed

    • ●

      removed the optional property data/created_at from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/enable_sip_trunking from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/endpoint from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/id from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/name from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/network_id from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/public_key from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/record_type from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/region from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/region_code from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/status from the response with the 202 status

      response-optional-property-removed

    • ●

      removed the optional property data/updated_at from the response with the 202 status

      response-optional-property-removed

    • ○

      added WireguardInterface RegionOut to the data response property allOf list for the response status 202

      response-property-all-of-added

  • 30cb1ddce91b113See the full diff
    • ▲

      the data response's property type/format changed from / to object/ for status 202

      response-property-type-changed

    • ○

      added the optional property data/created_at to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/enable_sip_trunking to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/endpoint to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/id to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/name to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/network_id to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/public_key to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/record_type to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/region to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/region_code to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/status to the response with the 202 status

      response-optional-property-added

    • ○

      added the optional property data/updated_at to the response with the 202 status

      response-optional-property-added

    • ○

      removed WireguardInterface RegionOut from the data response property allOf list for the response status 202

      response-property-all-of-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog