FQDNs V1

FQDN operations V1

Create an FQDN

Creates a new FQDN object.

Request
Request Body schema: application/json
required

FQDN to add

connection_id
required
string
fqdn
required
string
port
integer
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.

Enum: "a" "srv"
Responses
200

FQDN created response

Response Schema: application/json
id
required
string
connection_id
required
string
fqdn
required
string
port
integer
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.

Enum: "a" "srv"
400

Bad request

401

Unauthorized

post/security/fqdns
Request samples
application/json
{
  • "connection_id": "string",
  • "fqdn": "string",
  • "port": 0,
  • "dns_record_type": "a"
}
Response samples
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "fqdn": "string",
  • "port": 0,
  • "dns_record_type": "a"
}

List all FQDNs

Returns a list of your FQDNs.

Request
query Parameters
page
integer
Default: 1

Page number of results to load

per_page
integer <= 1000
Default: 100

Number of results per page

Responses
200

FQDN response

Response Schema: application/json
Array
id
required
string
connection_id
required
string
fqdn
required
string
port
integer
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.

Enum: "a" "srv"
401

Unauthorized

get/security/fqdns
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "connection_id": "string",
    • "fqdn": "string",
    • "port": 0,
    • "dns_record_type": "a"
    }
]
Update an FQDN
Updates the specified FQDN with the values of the parameters passed. Any parameters not included in the request will be left unchanged.


Request 
path Parameters
id
required
string
ID of FQDN to update


 
Request Body schema: application/json
required
Updated FQDN object


connection_id
required
string
 
fqdn
required
string
 
port
integer
 
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.


 Enum: "a" "srv"  
Responses 
200
FQDN updated response


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
fqdn
required
string
 
port
integer
 
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.


 Enum: "a" "srv"  
400
Bad request


401
Unauthorized


put/security/fqdns/{id}
Request samples 
application/json
{
  • "connection_id": "string",
  • "fqdn": "string",
  • "port": 0,
  • "dns_record_type": "a"
}
Response samples 
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "fqdn": "string",
  • "port": 0,
  • "dns_record_type": "a"
}
Delete an FQDN
Permanently deletes an FQDN.


Request 
path Parameters
id
required
string
ID of FQDN to delete


 
Responses 
200
FQDN deleted response


Response Schema: application/json
id
required
string
 
connection_id
required
string
 
fqdn
required
string
 
port
integer
 
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.


 Enum: "a" "srv"  
404
Resource not found


delete/security/fqdns/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "connection_id": "string",
  • "fqdn": "string",
  • "port": 0,
  • "dns_record_type": "a"
}