Retrieve a WireGuard Interfaces
GET/wireguard_interfaces/:id
Retrieve a WireGuard Interfaces.
Request
Path Parameters
Identifies the resource.
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
data
object
Identifies the resource.
Identifies the type of the resource.
ISO 8601 formatted date-time indicating when the resource was created.
ISO 8601 formatted date-time indicating when the resource was updated.
The id of the network associated with the interface.
A user specified name for the interface.
Possible values: [created
, provisioning
, provisioned
, deleting
]
The current status of the interface deployment.
The Telnyx WireGuard peers Peer.endpoint
value.
The Telnyx WireGuard peers Peer.PublicKey
.
Enable SIP traffic forwarding over VPN interface.
The region interface is deployed to.
region
object
Region code of the interface.
Region name of the interface.
Identifies the type of the resource.
{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": true,
"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=",
"enable_sip_trunking": true,
"region_code": "ashburn-va",
"region": {
"code": "ashburn-va",
"name": "Ashburn",
"record_type": "region"
}
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}