FQDNs

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": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}

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": {
    • "total_pages": 3,
    • "total_results": 55,
    • "page_number": 2,
    • "page_size": 25
    }
}