Authorized IPs V1

IP operations for Connections

Create an authorized IP

Creates a new authorized IP object.

Request
Request Body schema: application/json
required

Authorized IP to add

connection_id
required
string
ip_address
required
string
Responses
200

Authorized IP created response

Response Schema: application/json
id
required
string
ip_address
required
string
port
required
integer
Default: 5060
400

Bad request

401

Unauthorized

post/security/authorized_ips
Request samples
application/json
{
  • "connection_id": "string",
  • "ip_address": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "ip_address": "string",
  • "port": 5060
}

Retrieve all authorized IPs

Returns a list of your authorized IPs.

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

Authorized IP response

Response Schema: application/json
Array
id
required
string
ip_address
required
string
port
required
integer
Default: 5060
401

Unauthorized

get/security/authorized_ips
Request samples 
Response samples 
application/json
[
  • {
    • "id": "string",
    • "ip_address": "string",
    • "port": 5060
    }
]
Update an authorized IP
Updates the specified authorized IP 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 Authorized IP to update


 
Request Body schema: application/json
required
Updated Authorized IP object


connection_id
required
string
 
ip_address
required
string
 
Responses 
200
Authorized IP updated response


Response Schema: application/json
id
required
string
 
ip_address
required
string
 
port
required
integer
 Default:  5060
 
400
Bad request


401
Unauthorized


put/security/authorized_ips/{id}
Request samples 
application/json
{
  • "connection_id": "string",
  • "ip_address": "string"
}
Response samples 
application/json
{
  • "id": "string",
  • "ip_address": "string",
  • "port": 5060
}
Delete an authorized IP
Permanently deletes an authorized IP.


Request 
path Parameters
id
required
string
ID of Authorized IP to delete


 
Responses 
200
Authorized IP deleted response


Response Schema: application/json
id
required
string
 
ip_address
required
string
 
port
required
integer
 Default:  5060
 
404
Resource not found


delete/security/authorized_ips/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "ip_address": "string",
  • "port": 5060
}