Skip to main content

Set a connection to use IP authentication

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

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

Responses ​

200: IP Authentication creation response

Schema

    success booleanrequired
    message stringrequired
    ip_authentication_method stringrequired

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

    Default value: tech-prefix

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

400: Bad Request

401: Unauthorized

404: Record Not Found

Request samples

curl -L -X POST 'https://api.telnyx.com/security/connections/:connection_id/ip_authentication' \
-H 'Accept: application/json'

Response samples

{
  "success": true,
  "message": "string",
  "ip_authentication_method": "tech-prefix"
}