IP Authentication for Connections V1

IP Authentication operations for connections

Set a connection to use IP authentication

Set a connection to use IP authentication:

Note: authorized IP addresses are not added via this endpoint. Please see the authorized IP endpoints for operations involving adding and removing authorized IPs.

Request
path Parameters
connection_id
required
string

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

Responses
200

IP Authentication creation response

Response Schema: application/json
success
required
boolean
message
required
string
ip_authentication_method
required
string
Default: "tech-prefix"

The method of IP authentication to use along with the connection. Defaults to tech-prefix.

Enum: "tech-prefix" "token" "p-charge-info"
400

Bad Request

401

Unauthorized

404

Record Not Found

post/security/connections/{connection_id}/ip_authentication
Request samples 
Response samples 
application/json
{
  • "success": true,
  • "message": "string",
  • "ip_authentication_method": "tech-prefix"
}
Update IP authentication strategy for a connection
Updates the IP authentication strategy used for the connection.


Request 
path Parameters
connection_id
required
string
ID of the connection whose IP authentication is to be updated


 
Request Body schema: application/json
required
IP authentication strategy details


ip_authentication_method
required
string
 Default:  "tech-prefix"
The method of IP authentication to use along with the connection.
            Defaults to tech-prefix.


 Enum: "tech-prefix" "token" "p-charge-info"  
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
IP authentication update response


Response Schema: application/json
success
required
boolean
 
message
required
string
 
ip_authentication_method
required
string
 Default:  "tech-prefix"
The method of IP authentication to use along with the connection.
            Defaults to tech-prefix.


 Enum: "tech-prefix" "token" "p-charge-info"  
400
Bad Request


401
Unauthorized


404
Record Not Found


422
Unprocessable Request


put/security/connections/{connection_id}/ip_authentication
Request samples 
application/json
{
  • "ip_authentication_method": "tech-prefix",
  • "webhook_url": "string",
  • "failover_url": "string"
}
Response samples 
application/json
{
  • "success": true,
  • "message": "string",
  • "ip_authentication_method": "tech-prefix"
}
Generate a token suggestion
Retrieves a suggestion for a token to use with the IP authentication method
          with a connection.


Request 
path Parameters
connection_id
required
string
ID of the connection to get a token suggestion for


 
Responses 
200
successful token suggestion response


Response Schema: application/json
token_suggestion
string
 
400
Bad Request


401
Unauthorized


404
Record Not Found


422
Unprocessable Request


get/security/connections/{connection_id}/ip_authentication/token_suggestion
Request samples 
Response samples 
application/json
{
  • "token_suggestion": "string"
}