FQDNs API

FQDN operations

List all Access FQDNs

SecuritybearerAuth
Request
query Parameters
page[number]
integer
Default: 1
page[size]
integer <= 250
Default: 20
Responses
200

Successful Response

Response Schema: application/json
Array of objects (Data)
object (PaginationMeta)
get/access_fqdns
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.AccessFqdn.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "created_at": "2019-08-24T14:15:22Z",
      • "description": "string",
      • "fqdn": "string",
      • "id": "string",
      • "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Create new Access FQDN

SecuritybearerAuth
Request
Request Body schema: application/json
required
description
string (Description)
fqdn
required
string (Fully Qualified Domain Name (FQDN))
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
fqdn
string (Fully Qualified Domain Name (FQDN))
id
string (Id)
updated_at
string <date-time> (Updated At)
post/access_fqdns
Request samples
application/json
{
  • "description": "string",
  • "fqdn": "string"
}
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "fqdn": "string",
  • "id": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete Access FQDN

SecuritybearerAuth
Request
path Parameters
fqdn_id
required
string
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
fqdn
string (Fully Qualified Domain Name (FQDN))
id
string (Id)
updated_at
string <date-time> (Updated At)
delete/access_fqdns/{fqdn_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.AccessFqdn.retrieve('fqdn_id')
res.delete()
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "fqdn": "string",
  • "id": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List an Access FQDN

SecuritybearerAuth
Request
path Parameters
fqdn_id
required
string
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
fqdn
string (Fully Qualified Domain Name (FQDN))
id
string (Id)
updated_at
string <date-time> (Updated At)
get/access_fqdns/{fqdn_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.AccessFqdn.retrieve("fqdn_id")
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "fqdn": "string",
  • "id": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update Access FQDN

SecuritybearerAuth
Request
path Parameters
fqdn_id
required
string
Request Body schema: application/json
required
description
required
string (Description)
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
fqdn
string (Fully Qualified Domain Name (FQDN))
id
string (Id)
updated_at
string <date-time> (Updated At)
patch/access_fqdns/{fqdn_id}
Request samples
application/json
{
  • "description": "string"
}
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "fqdn": "string",
  • "id": "string",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List Access FQDN's IP Addresses

SecuritybearerAuth
Request
path Parameters
fqdn_id
required
string
query Parameters
page[number]
integer
Default: 1
page[size]
integer <= 250
Default: 20
Responses
200

Successful Response

Response Schema: application/json
Array of objects (Data)
object (PaginationMeta)
get/access_fqdns/{fqdn_id}/ips
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.AccessFqdns.retrieve_ip.retrieve("fqdn_id",page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "created_at": "2019-08-24T14:15:22Z",
      • "fqdn": "string",
      • "ip_address": "192.168.0.1",
      • "updated_at": "2019-08-24T14:15:22Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

List FQDNs

Get all FQDNs belonging to the user that match the given filters.

SecuritybearerAuth
Request
query Parameters
page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

filter[connection_id]
string

ID of the FQDN connection to which the FQDN belongs.

filter[fqdn]
string

FQDN represented by the resource.

Example: filter[fqdn]=example.com
filter[port]
integer

Port to use when connecting to the FQDN.

Example: filter[port]=5060
filter[dns_record_type]
string

DNS record type used by the FQDN.

Example: filter[dns_record_type]=a
Responses
200

Successful response with a list of FQDN connections.

Response Schema: application/json
Array of objects (Fqdn)
object (PaginationMeta)
400

Bad request

401

Unauthorized

get/fqdns
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.FQDN.list(page={"number":1,"size":20})
Response samples
application/json
{
  • "data": [
    • {
      • "connection_id": "1516447646313612565",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "dns_record_type": "a",
      • "fqdn": "example.com",
      • "id": "1293384261075731499",
      • "port": 5060,
      • "record_type": "fqdn",
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Create an FQDN

Create a new FQDN object.

SecuritybearerAuth
Request
Request Body schema: application/json
connection_id
required
string

ID of the FQDN connection to which this IP should be attached.

dns_record_type
required
string

The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

fqdn
required
string

FQDN represented by this resource.

port
integer
Default: 5060

Port to use when connecting to this FQDN.

Responses
201

Successful response with details about an FQDN connection.

Response Schema: application/json
object (Fqdn)
connection_id
string

ID of the FQDN connection to which this FQDN is attached.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

dns_record_type
string

The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

fqdn
string

FQDN represented by this resource.

id
string <int64>

Identifies the resource.

port
integer
Default: 5060

Port to use when connecting to this FQDN.

record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

400

Bad request

401

Unauthorized

post/fqdns
Request samples
application/json
{
  • "connection_id": "1516447646313612565",
  • "dns_record_type": "a",
  • "fqdn": "example.com",
  • "port": 8080
}
Response samples
application/json
{
  • "data": {
    • "connection_id": "1516447646313612565",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dns_record_type": "a",
    • "fqdn": "example.com",
    • "id": "1293384261075731499",
    • "port": 5060,
    • "record_type": "fqdn",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Delete an FQDN

Delete an FQDN.

SecuritybearerAuth
Request
path Parameters
id
required
string <int64>

Identifies the resource.

Example: 1517907029795014409
Responses
200

Successful response with details about an FQDN connection.

Response Schema: application/json
object (Fqdn)
connection_id
string

ID of the FQDN connection to which this FQDN is attached.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

dns_record_type
string

The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

fqdn
string

FQDN represented by this resource.

id
string <int64>

Identifies the resource.

port
integer
Default: 5060

Port to use when connecting to this FQDN.

record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

400

Bad request

401

Unauthorized

delete/fqdns/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.FQDN.retrieve("id")
res.delete()
Response samples
application/json
{
  • "data": {
    • "connection_id": "1516447646313612565",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dns_record_type": "a",
    • "fqdn": "example.com",
    • "id": "1293384261075731499",
    • "port": 5060,
    • "record_type": "fqdn",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Retrieve an FQDN

Return the details regarding a specific FQDN.

SecuritybearerAuth
Request
path Parameters
id
required
string <int64>

Identifies the resource.

Example: 1517907029795014409
Responses
200

Successful response with details about an FQDN connection.

Response Schema: application/json
object (Fqdn)
connection_id
string

ID of the FQDN connection to which this FQDN is attached.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

dns_record_type
string

The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

fqdn
string

FQDN represented by this resource.

id
string <int64>

Identifies the resource.

port
integer
Default: 5060

Port to use when connecting to this FQDN.

record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

400

Bad request

401

Unauthorized

get/fqdns/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.FQDN.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "connection_id": "1516447646313612565",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dns_record_type": "a",
    • "fqdn": "example.com",
    • "id": "1293384261075731499",
    • "port": 5060,
    • "record_type": "fqdn",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Update an FQDN

Update the details of a specific FQDN.

SecuritybearerAuth
Request
path Parameters
id
required
string <int64>

Identifies the resource.

Example: 1517907029795014409
Request Body schema: application/json
connection_id
string

ID of the FQDN connection to which this IP should be attached.

dns_record_type
string

The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

fqdn
string

FQDN represented by this resource.

port
integer
Default: 5060

Port to use when connecting to this FQDN.

Responses
200

Successful response with details about an FQDN connection.

Response Schema: application/json
object (Fqdn)
connection_id
string

ID of the FQDN connection to which this FQDN is attached.

created_at
string

ISO 8601 formatted date indicating when the resource was created.

dns_record_type
string

The DNS record type for the FQDN. For cases where a port is not set, the DNS record type must be 'srv'. For cases where a port is set, the DNS record type must be 'a'. If the DNS record type is 'a' and a port is not specified, 5060 will be used.

fqdn
string

FQDN represented by this resource.

id
string <int64>

Identifies the resource.

port
integer
Default: 5060

Port to use when connecting to this FQDN.

record_type
string

Identifies the type of the resource.

updated_at
string

ISO 8601 formatted date indicating when the resource was updated.

400

Bad request

401

Unauthorized

patch/fqdns/{id}
Request samples
application/json
{
  • "connection_id": "1516447646313612565",
  • "dns_record_type": "a",
  • "fqdn": "example.com",
  • "port": 8080
}
Response samples
application/json
{
  • "data": {
    • "connection_id": "1516447646313612565",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dns_record_type": "a",
    • "fqdn": "example.com",
    • "id": "1293384261075731499",
    • "port": 5060,
    • "record_type": "fqdn",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}