IP Addresses API

IP Address Operations API

List all Access IP Addresses

SecuritybearerAuth
Request
query Parameters
filter[ip_source]
string
filter[ip_address]
string
filter[status]
string (CloudflareSyncStatus)

An enumeration.

Enum: "pending" "added"
filter[created_at][gt]
string <date-time>
filter[created_at][lt]
string <date-time>
page[number]
integer
Default: 1
page[size]
integer <= 250
Default: 20
Responses
200

Successful Response

Response Schema: application/json
required
Array of objects (Data)
required
object (PaginationMeta)
422

Validation Error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/access_ip_address
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.AccessIpAddress.list(filter={"ip_source":"string","ip_address":"string"})
Response samples
application/json
{
  • "data": [
    • {
      • "created_at": "2019-08-24T14:15:22Z",
      • "description": "string",
      • "id": "string",
      • "ip_address": "string",
      • "source": "string",
      • "status": "pending",
      • "updated_at": "2019-08-24T14:15:22Z",
      • "user_id": "string"
      }
    ],
  • "meta": {
    • "page_number": 2,
    • "page_size": 25,
    • "total_pages": 3,
    • "total_results": 55
    }
}

Create new Access IP Address

SecuritybearerAuth
Request
Request Body schema: application/json
required
description
string (Description)
ip_address
required
string (Ip Address)
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
id
required
string (Id)
ip_address
required
string (Ip Address)
source
required
string (Source)
status
required
string (CloudflareSyncStatus)

An enumeration.

Enum: "pending" "added"
updated_at
string <date-time> (Updated At)
user_id
required
string (User Id)
422

Validation Error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
post/access_ip_address
Request samples
application/json
{
  • "description": "string",
  • "ip_address": "string"
}
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "ip_address": "string",
  • "source": "string",
  • "status": "pending",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": "string"
}

Delete access IP address

SecuritybearerAuth
Request
path Parameters
access_ip_address_id
required
string
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
id
required
string (Id)
ip_address
required
string (Ip Address)
source
required
string (Source)
status
required
string (CloudflareSyncStatus)

An enumeration.

Enum: "pending" "added"
updated_at
string <date-time> (Updated At)
user_id
required
string (User Id)
delete/access_ip_address/{access_ip_address_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.AccessIpAddress.retrieve('access_ip_address_id')
res.delete()
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "ip_address": "string",
  • "source": "string",
  • "status": "pending",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": "string"
}

Retrieve an access IP address

SecuritybearerAuth
Request
path Parameters
access_ip_address_id
required
string
Responses
200

Successful Response

Response Schema: application/json
created_at
string <date-time> (Created At)
description
string (Description)
id
required
string (Id)
ip_address
required
string (Ip Address)
source
required
string (Source)
status
required
string (CloudflareSyncStatus)

An enumeration.

Enum: "pending" "added"
updated_at
string <date-time> (Updated At)
user_id
required
string (User Id)
get/access_ip_address/{access_ip_address_id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.AccessIpAddress.retrieve("access_ip_address_id")
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "ip_address": "string",
  • "source": "string",
  • "status": "pending",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_id": "string"
}