FQDN Authentication for Connections V1

FQDN Authentication operations for connections

Set a connection to use FQDN authentication

Set a connection to use FQDN authentication.

Note: domains are not added via this endpoint. Please see the FQDN endpoints for operations involving adding and removing domains.

The fields user_name and password are not required for this authentication type, but the connection will be unusable on outbound profiles if they are not set.

Request
path Parameters
connection_id
required
string

ID of the connection which you will set to use this type of authentication

Request Body schema: application/json

User name and password credential details

user_name
required
string

user_name that will be sent when using the connection. Must be globally unique among all connections, not just FQDN authentication connections. Case-insensitive.

password
required
string

password that will be sent when using the connection. Must be at least 8 characters or more in length.

ip_authentication_method
string
Default: "tech-prefix"

The method of authentication to use if this FQDN auth strategy uses IP-based outbound. Defaults to "tech-prefix". Has no effect if this auth strategy uses credentials for outbound authentication.

Enum: "tech-prefix" "token" "p-charge-info"
fqdn_outbound_authentication
string
Default: "credential-authentication"

The method of authentication to use for outbound calls on this authentication strategy. Defaults to "credential-authentication".

Enum: "credential-authentication" "ip-authentication"
webhook_url
string

URL to which Telnyx will deliver your Call Control webhooks

failover_url
string

URL to which Telnyx will deliver your Call Control webhooks if we get an error response from your webhook_url

Responses
200

Fqdn Authentication creation response

Response Schema: application/json
success
required
boolean
message
required
string
object
400

Bad Request

401

Unauthorized

404

Record Not Found

post/security/connections/{connection_id}/fqdn_authentication
Request samples
application/json
{
  • "user_name": "string",
  • "password": "string",
  • "ip_authentication_method": "tech-prefix",
  • "fqdn_outbound_authentication": "credential-authentication",
  • "webhook_url": "string",
  • "failover_url": "string"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}

Update FQDN Authentication

Updates the connection credentials with the values of the parameters passed. Any parameters not included in the request will be left unchanged.

Request
path Parameters
connection_id
required
string

ID of the connection whose credentials are to be updated

Request Body schema: application/json

FQDN Authentication details

user_name
required
string

user_name that will be sent when using the connection. Must be globally unique among all connections, not just FQDN authentication connections. Case-insensitive.

password
required
string

password that will be sent when using the connection. Must be at least 8 characters or more in length.

ip_authentication_method
string
Default: "tech-prefix"

The method of authentication to use if this FQDN auth strategy uses IP-based outbound. Defaults to "tech-prefix". Has no effect if this auth strategy uses credentials for outbound authentication.

Enum: "tech-prefix" "token" "p-charge-info"
fqdn_outbound_authentication
string
Default: "credential-authentication"

The method of authentication to use for outbound calls on this authentication strategy. Defaults to "credential-authentication".

Enum: "credential-authentication" "ip-authentication"
webhook_url
string

URL to which Telnyx will deliver your Call Control webhooks

failover_url
string

URL to which Telnyx will deliver your Call Control webhooks if we get an error response from your webhook_url

Responses
200

FQDN Authentication update response

Response Schema: application/json
success
required
boolean
message
required
string
object
400

Bad Request

401

Unauthorized

404

Record Not Found

put/security/connections/{connection_id}/fqdn_authentication
Request samples
application/json
{
  • "user_name": "string",
  • "password": "string",
  • "ip_authentication_method": "tech-prefix",
  • "fqdn_outbound_authentication": "credential-authentication",
  • "webhook_url": "string",
  • "failover_url": "string"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}