Skip to main content

Set a connection to use FQDN authentication

POST 
/security/connections/:connection_id/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 stringrequired

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

Body

User name and password credential details

    user_name stringrequired

    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 stringrequired

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

    ip_authentication_method string

    Possible values: [tech-prefix, token, p-charge-info]

    Default value: 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.

    fqdn_outbound_authentication string

    Possible values: [credential-authentication, ip-authentication]

    Default value: credential-authentication

    The method of authentication to use for outbound calls on this authentication strategy. Defaults to "credential-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

Schema

    success booleanrequired
    message stringrequired

    reasons

    object

    property name*

    string[]

  • Array [

    • string

  • ]

400: Bad Request

401: Unauthorized

404: Record Not Found

Request samples

curl -L 'https://api.telnyx.com/security/connections/:connection_id/fqdn_authentication' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "user_name": "string",
  "password": "string",
  "ip_authentication_method": "tech-prefix",
  "fqdn_outbound_authentication": "credential-authentication",
  "webhook_url": "string",
  "failover_url": "string"
}'

Response samples

{
  "success": true,
  "message": "string",
  "reasons": {}
}